xref: /openbmc/linux/sound/soc/sh/rcar/ssi.c (revision ecd25094)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Renesas R-Car SSIU/SSI support
4 //
5 // Copyright (C) 2013 Renesas Solutions Corp.
6 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 //
8 // Based on fsi.c
9 // Kuninori Morimoto <morimoto.kuninori@renesas.com>
10 
11 /*
12  * you can enable below define if you don't need
13  * SSI interrupt status debug message when debugging
14  * see rsnd_dbg_irq_status()
15  *
16  * #define RSND_DEBUG_NO_IRQ_STATUS 1
17  */
18 
19 #include <sound/simple_card_utils.h>
20 #include <linux/delay.h>
21 #include "rsnd.h"
22 #define RSND_SSI_NAME_SIZE 16
23 
24 /*
25  * SSICR
26  */
27 #define	FORCE		(1 << 31)	/* Fixed */
28 #define	DMEN		(1 << 28)	/* DMA Enable */
29 #define	UIEN		(1 << 27)	/* Underflow Interrupt Enable */
30 #define	OIEN		(1 << 26)	/* Overflow Interrupt Enable */
31 #define	IIEN		(1 << 25)	/* Idle Mode Interrupt Enable */
32 #define	DIEN		(1 << 24)	/* Data Interrupt Enable */
33 #define	CHNL_4		(1 << 22)	/* Channels */
34 #define	CHNL_6		(2 << 22)	/* Channels */
35 #define	CHNL_8		(3 << 22)	/* Channels */
36 #define DWL_MASK	(7 << 19)	/* Data Word Length mask */
37 #define	DWL_8		(0 << 19)	/* Data Word Length */
38 #define	DWL_16		(1 << 19)	/* Data Word Length */
39 #define	DWL_18		(2 << 19)	/* Data Word Length */
40 #define	DWL_20		(3 << 19)	/* Data Word Length */
41 #define	DWL_22		(4 << 19)	/* Data Word Length */
42 #define	DWL_24		(5 << 19)	/* Data Word Length */
43 #define	DWL_32		(6 << 19)	/* Data Word Length */
44 
45 /*
46  * System word length
47  */
48 #define	SWL_16		(1 << 16)	/* R/W System Word Length */
49 #define	SWL_24		(2 << 16)	/* R/W System Word Length */
50 #define	SWL_32		(3 << 16)	/* R/W System Word Length */
51 
52 #define	SCKD		(1 << 15)	/* Serial Bit Clock Direction */
53 #define	SWSD		(1 << 14)	/* Serial WS Direction */
54 #define	SCKP		(1 << 13)	/* Serial Bit Clock Polarity */
55 #define	SWSP		(1 << 12)	/* Serial WS Polarity */
56 #define	SDTA		(1 << 10)	/* Serial Data Alignment */
57 #define	PDTA		(1 <<  9)	/* Parallel Data Alignment */
58 #define	DEL		(1 <<  8)	/* Serial Data Delay */
59 #define	CKDV(v)		(v <<  4)	/* Serial Clock Division Ratio */
60 #define	TRMD		(1 <<  1)	/* Transmit/Receive Mode Select */
61 #define	EN		(1 <<  0)	/* SSI Module Enable */
62 
63 /*
64  * SSISR
65  */
66 #define	UIRQ		(1 << 27)	/* Underflow Error Interrupt Status */
67 #define	OIRQ		(1 << 26)	/* Overflow Error Interrupt Status */
68 #define	IIRQ		(1 << 25)	/* Idle Mode Interrupt Status */
69 #define	DIRQ		(1 << 24)	/* Data Interrupt Status Flag */
70 
71 /*
72  * SSIWSR
73  */
74 #define CONT		(1 << 8)	/* WS Continue Function */
75 #define WS_MODE		(1 << 0)	/* WS Mode */
76 
77 #define SSI_NAME "ssi"
78 
79 struct rsnd_ssi {
80 	struct rsnd_mod mod;
81 
82 	u32 flags;
83 	u32 cr_own;
84 	u32 cr_clk;
85 	u32 cr_mode;
86 	u32 cr_en;
87 	u32 wsr;
88 	int chan;
89 	int rate;
90 	int irq;
91 	unsigned int usrcnt;
92 
93 	/* for PIO */
94 	int byte_pos;
95 	int byte_per_period;
96 	int next_period_byte;
97 };
98 
99 /* flags */
100 #define RSND_SSI_CLK_PIN_SHARE		(1 << 0)
101 #define RSND_SSI_NO_BUSIF		(1 << 1) /* SSI+DMA without BUSIF */
102 #define RSND_SSI_PROBED			(1 << 2)
103 
104 #define for_each_rsnd_ssi(pos, priv, i)					\
105 	for (i = 0;							\
106 	     (i < rsnd_ssi_nr(priv)) &&					\
107 		((pos) = ((struct rsnd_ssi *)(priv)->ssi + i));		\
108 	     i++)
109 
110 #define rsnd_ssi_get(priv, id) ((struct rsnd_ssi *)(priv->ssi) + id)
111 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
112 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
113 #define rsnd_ssi_is_parent(ssi, io) ((ssi) == rsnd_io_to_mod_ssip(io))
114 #define rsnd_ssi_is_multi_slave(mod, io) \
115 	(rsnd_ssi_multi_slaves(io) & (1 << rsnd_mod_id(mod)))
116 #define rsnd_ssi_is_run_mods(mod, io) \
117 	(rsnd_ssi_run_mods(io) & (1 << rsnd_mod_id(mod)))
118 #define rsnd_ssi_can_output_clk(mod) (!__rsnd_ssi_is_pin_sharing(mod))
119 
120 static int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
121 
122 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io)
123 {
124 	struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
125 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
126 	int use_busif = 0;
127 
128 	if (!rsnd_ssi_is_dma_mode(mod))
129 		return 0;
130 
131 	if (!(rsnd_flags_has(ssi, RSND_SSI_NO_BUSIF)))
132 		use_busif = 1;
133 	if (rsnd_io_to_mod_src(io))
134 		use_busif = 1;
135 
136 	return use_busif;
137 }
138 
139 static void rsnd_ssi_status_clear(struct rsnd_mod *mod)
140 {
141 	rsnd_mod_write(mod, SSISR, 0);
142 }
143 
144 static u32 rsnd_ssi_status_get(struct rsnd_mod *mod)
145 {
146 	return rsnd_mod_read(mod, SSISR);
147 }
148 
149 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
150 				  u32 bit)
151 {
152 	struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
153 	struct device *dev = rsnd_priv_to_dev(priv);
154 	u32 status;
155 	int i;
156 
157 	for (i = 0; i < 1024; i++) {
158 		status = rsnd_ssi_status_get(mod);
159 		if (status & bit)
160 			return;
161 
162 		udelay(5);
163 	}
164 
165 	dev_warn(dev, "%s status check failed\n", rsnd_mod_name(mod));
166 }
167 
168 static u32 rsnd_ssi_multi_slaves(struct rsnd_dai_stream *io)
169 {
170 	struct rsnd_mod *mod;
171 	enum rsnd_mod_type types[] = {
172 		RSND_MOD_SSIM1,
173 		RSND_MOD_SSIM2,
174 		RSND_MOD_SSIM3,
175 	};
176 	int i, mask;
177 
178 	mask = 0;
179 	for (i = 0; i < ARRAY_SIZE(types); i++) {
180 		mod = rsnd_io_to_mod(io, types[i]);
181 		if (!mod)
182 			continue;
183 
184 		mask |= 1 << rsnd_mod_id(mod);
185 	}
186 
187 	return mask;
188 }
189 
190 static u32 rsnd_ssi_run_mods(struct rsnd_dai_stream *io)
191 {
192 	struct rsnd_mod *ssi_mod = rsnd_io_to_mod_ssi(io);
193 	struct rsnd_mod *ssi_parent_mod = rsnd_io_to_mod_ssip(io);
194 	u32 mods;
195 
196 	mods = rsnd_ssi_multi_slaves_runtime(io) |
197 		1 << rsnd_mod_id(ssi_mod);
198 
199 	if (ssi_parent_mod)
200 		mods |= 1 << rsnd_mod_id(ssi_parent_mod);
201 
202 	return mods;
203 }
204 
205 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io)
206 {
207 	if (rsnd_runtime_is_multi_ssi(io))
208 		return rsnd_ssi_multi_slaves(io);
209 
210 	return 0;
211 }
212 
213 static u32 rsnd_rdai_width_to_swl(struct rsnd_dai *rdai)
214 {
215 	struct rsnd_priv *priv = rsnd_rdai_to_priv(rdai);
216 	struct device *dev = rsnd_priv_to_dev(priv);
217 	int width = rsnd_rdai_width_get(rdai);
218 
219 	switch (width) {
220 	case 32: return SWL_32;
221 	case 24: return SWL_24;
222 	case 16: return SWL_16;
223 	}
224 
225 	dev_err(dev, "unsupported slot width value: %d\n", width);
226 	return 0;
227 }
228 
229 unsigned int rsnd_ssi_clk_query(struct rsnd_dai *rdai,
230 		       int param1, int param2, int *idx)
231 {
232 	struct rsnd_priv *priv = rsnd_rdai_to_priv(rdai);
233 	int ssi_clk_mul_table[] = {
234 		1, 2, 4, 8, 16, 6, 12,
235 	};
236 	int j, ret;
237 	unsigned int main_rate;
238 	int width = rsnd_rdai_width_get(rdai);
239 
240 	for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
241 
242 		/*
243 		 * It will set SSIWSR.CONT here, but SSICR.CKDV = 000
244 		 * with it is not allowed. (SSIWSR.WS_MODE with
245 		 * SSICR.CKDV = 000 is not allowed either).
246 		 * Skip it. See SSICR.CKDV
247 		 */
248 		if (j == 0)
249 			continue;
250 
251 		main_rate = width * param1 * param2 * ssi_clk_mul_table[j];
252 
253 		ret = rsnd_adg_clk_query(priv, main_rate);
254 		if (ret < 0)
255 			continue;
256 
257 		if (idx)
258 			*idx = j;
259 
260 		return main_rate;
261 	}
262 
263 	return 0;
264 }
265 
266 static int rsnd_ssi_master_clk_start(struct rsnd_mod *mod,
267 				     struct rsnd_dai_stream *io)
268 {
269 	struct rsnd_priv *priv = rsnd_io_to_priv(io);
270 	struct device *dev = rsnd_priv_to_dev(priv);
271 	struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
272 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
273 	int chan = rsnd_runtime_channel_for_ssi(io);
274 	int idx, ret;
275 	unsigned int main_rate;
276 	unsigned int rate = rsnd_io_is_play(io) ?
277 		rsnd_src_get_out_rate(priv, io) :
278 		rsnd_src_get_in_rate(priv, io);
279 
280 	if (!rsnd_rdai_is_clk_master(rdai))
281 		return 0;
282 
283 	if (!rsnd_ssi_can_output_clk(mod))
284 		return 0;
285 
286 	if (rsnd_ssi_is_multi_slave(mod, io))
287 		return 0;
288 
289 	if (ssi->usrcnt > 0) {
290 		if (ssi->rate != rate) {
291 			dev_err(dev, "SSI parent/child should use same rate\n");
292 			return -EINVAL;
293 		}
294 
295 		if (ssi->chan != chan) {
296 			dev_err(dev, "SSI parent/child should use same chan\n");
297 			return -EINVAL;
298 		}
299 
300 		return 0;
301 	}
302 
303 	if (rsnd_runtime_is_tdm_split(io))
304 		chan = rsnd_io_converted_chan(io);
305 
306 	chan = rsnd_channel_normalization(chan);
307 
308 	main_rate = rsnd_ssi_clk_query(rdai, rate, chan, &idx);
309 	if (!main_rate) {
310 		dev_err(dev, "unsupported clock rate\n");
311 		return -EIO;
312 	}
313 
314 	ret = rsnd_adg_ssi_clk_try_start(mod, main_rate);
315 	if (ret < 0)
316 		return ret;
317 
318 	/*
319 	 * SSI clock will be output contiguously
320 	 * by below settings.
321 	 * This means, rsnd_ssi_master_clk_start()
322 	 * and rsnd_ssi_register_setup() are necessary
323 	 * for SSI parent
324 	 *
325 	 * SSICR  : FORCE, SCKD, SWSD
326 	 * SSIWSR : CONT
327 	 */
328 	ssi->cr_clk = FORCE | rsnd_rdai_width_to_swl(rdai) |
329 			SCKD | SWSD | CKDV(idx);
330 	ssi->wsr = CONT;
331 	ssi->rate = rate;
332 	ssi->chan = chan;
333 
334 	dev_dbg(dev, "%s outputs %d chan %u Hz\n",
335 		rsnd_mod_name(mod), chan, rate);
336 
337 	return 0;
338 }
339 
340 static void rsnd_ssi_master_clk_stop(struct rsnd_mod *mod,
341 				     struct rsnd_dai_stream *io)
342 {
343 	struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
344 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
345 
346 	if (!rsnd_rdai_is_clk_master(rdai))
347 		return;
348 
349 	if (!rsnd_ssi_can_output_clk(mod))
350 		return;
351 
352 	if (ssi->usrcnt > 1)
353 		return;
354 
355 	ssi->cr_clk	= 0;
356 	ssi->rate	= 0;
357 	ssi->chan	= 0;
358 
359 	rsnd_adg_ssi_clk_stop(mod);
360 }
361 
362 static void rsnd_ssi_config_init(struct rsnd_mod *mod,
363 				struct rsnd_dai_stream *io)
364 {
365 	struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
366 	struct rsnd_priv *priv = rsnd_rdai_to_priv(rdai);
367 	struct device *dev = rsnd_priv_to_dev(priv);
368 	struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
369 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
370 	u32 cr_own	= ssi->cr_own;
371 	u32 cr_mode	= ssi->cr_mode;
372 	u32 wsr		= ssi->wsr;
373 	int width;
374 	int is_tdm, is_tdm_split;
375 
376 	is_tdm		= rsnd_runtime_is_tdm(io);
377 	is_tdm_split	= rsnd_runtime_is_tdm_split(io);
378 
379 	if (is_tdm)
380 		dev_dbg(dev, "TDM mode\n");
381 	if (is_tdm_split)
382 		dev_dbg(dev, "TDM Split mode\n");
383 
384 	cr_own |= FORCE | rsnd_rdai_width_to_swl(rdai);
385 
386 	if (rdai->bit_clk_inv)
387 		cr_own |= SCKP;
388 	if (rdai->frm_clk_inv && !is_tdm)
389 		cr_own |= SWSP;
390 	if (rdai->data_alignment)
391 		cr_own |= SDTA;
392 	if (rdai->sys_delay)
393 		cr_own |= DEL;
394 
395 	/*
396 	 * TDM Mode
397 	 * see
398 	 *	rsnd_ssiu_init_gen2()
399 	 */
400 	wsr = ssi->wsr;
401 	if (is_tdm || is_tdm_split) {
402 		wsr	|= WS_MODE;
403 		cr_own	|= CHNL_8;
404 	}
405 
406 	/*
407 	 * We shouldn't exchange SWSP after running.
408 	 * This means, parent needs to care it.
409 	 */
410 	if (rsnd_ssi_is_parent(mod, io))
411 		goto init_end;
412 
413 	if (rsnd_io_is_play(io))
414 		cr_own |= TRMD;
415 
416 	cr_own &= ~DWL_MASK;
417 	width = snd_pcm_format_width(runtime->format);
418 	if (is_tdm_split) {
419 		/*
420 		 * The SWL and DWL bits in SSICR should be fixed at 32-bit
421 		 * setting when TDM split mode.
422 		 * see datasheet
423 		 *	Operation :: TDM Format Split Function (TDM Split Mode)
424 		 */
425 		width = 32;
426 	}
427 
428 	switch (width) {
429 	case 8:
430 		cr_own |= DWL_8;
431 		break;
432 	case 16:
433 		cr_own |= DWL_16;
434 		break;
435 	case 24:
436 		cr_own |= DWL_24;
437 		break;
438 	case 32:
439 		cr_own |= DWL_32;
440 		break;
441 	}
442 
443 	if (rsnd_ssi_is_dma_mode(mod)) {
444 		cr_mode = UIEN | OIEN |	/* over/under run */
445 			  DMEN;		/* DMA : enable DMA */
446 	} else {
447 		cr_mode = DIEN;		/* PIO : enable Data interrupt */
448 	}
449 
450 init_end:
451 	ssi->cr_own	= cr_own;
452 	ssi->cr_mode	= cr_mode;
453 	ssi->wsr	= wsr;
454 }
455 
456 static void rsnd_ssi_register_setup(struct rsnd_mod *mod)
457 {
458 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
459 
460 	rsnd_mod_write(mod, SSIWSR,	ssi->wsr);
461 	rsnd_mod_write(mod, SSICR,	ssi->cr_own	|
462 					ssi->cr_clk	|
463 					ssi->cr_mode	|
464 					ssi->cr_en);
465 }
466 
467 /*
468  *	SSI mod common functions
469  */
470 static int rsnd_ssi_init(struct rsnd_mod *mod,
471 			 struct rsnd_dai_stream *io,
472 			 struct rsnd_priv *priv)
473 {
474 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
475 
476 	if (!rsnd_ssi_is_run_mods(mod, io))
477 		return 0;
478 
479 	ssi->usrcnt++;
480 
481 	rsnd_mod_power_on(mod);
482 
483 	rsnd_ssi_config_init(mod, io);
484 
485 	rsnd_ssi_register_setup(mod);
486 
487 	/* clear error status */
488 	rsnd_ssi_status_clear(mod);
489 
490 	return 0;
491 }
492 
493 static int rsnd_ssi_quit(struct rsnd_mod *mod,
494 			 struct rsnd_dai_stream *io,
495 			 struct rsnd_priv *priv)
496 {
497 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
498 	struct device *dev = rsnd_priv_to_dev(priv);
499 
500 	if (!rsnd_ssi_is_run_mods(mod, io))
501 		return 0;
502 
503 	if (!ssi->usrcnt) {
504 		dev_err(dev, "%s usrcnt error\n", rsnd_mod_name(mod));
505 		return -EIO;
506 	}
507 
508 	rsnd_ssi_master_clk_stop(mod, io);
509 
510 	rsnd_mod_power_off(mod);
511 
512 	ssi->usrcnt--;
513 
514 	if (!ssi->usrcnt) {
515 		ssi->cr_own	= 0;
516 		ssi->cr_mode	= 0;
517 		ssi->wsr	= 0;
518 	}
519 
520 	return 0;
521 }
522 
523 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
524 			      struct rsnd_dai_stream *io,
525 			      struct snd_pcm_substream *substream,
526 			      struct snd_pcm_hw_params *params)
527 {
528 	struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
529 	unsigned int fmt_width = snd_pcm_format_width(params_format(params));
530 
531 	if (fmt_width > rdai->chan_width) {
532 		struct rsnd_priv *priv = rsnd_io_to_priv(io);
533 		struct device *dev = rsnd_priv_to_dev(priv);
534 
535 		dev_err(dev, "invalid combination of slot-width and format-data-width\n");
536 		return -EINVAL;
537 	}
538 
539 	return 0;
540 }
541 
542 static int rsnd_ssi_start(struct rsnd_mod *mod,
543 			  struct rsnd_dai_stream *io,
544 			  struct rsnd_priv *priv)
545 {
546 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
547 
548 	if (!rsnd_ssi_is_run_mods(mod, io))
549 		return 0;
550 
551 	/*
552 	 * EN will be set via SSIU :: SSI_CONTROL
553 	 * if Multi channel mode
554 	 */
555 	if (rsnd_ssi_multi_slaves_runtime(io))
556 		return 0;
557 
558 	/*
559 	 * EN is for data output.
560 	 * SSI parent EN is not needed.
561 	 */
562 	if (rsnd_ssi_is_parent(mod, io))
563 		return 0;
564 
565 	ssi->cr_en = EN;
566 
567 	rsnd_mod_write(mod, SSICR,	ssi->cr_own	|
568 					ssi->cr_clk	|
569 					ssi->cr_mode	|
570 					ssi->cr_en);
571 
572 	return 0;
573 }
574 
575 static int rsnd_ssi_stop(struct rsnd_mod *mod,
576 			 struct rsnd_dai_stream *io,
577 			 struct rsnd_priv *priv)
578 {
579 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
580 	u32 cr;
581 
582 	if (!rsnd_ssi_is_run_mods(mod, io))
583 		return 0;
584 
585 	if (rsnd_ssi_is_parent(mod, io))
586 		return 0;
587 
588 	cr  =	ssi->cr_own	|
589 		ssi->cr_clk;
590 
591 	/*
592 	 * disable all IRQ,
593 	 * Playback: Wait all data was sent
594 	 * Capture:  It might not receave data. Do nothing
595 	 */
596 	if (rsnd_io_is_play(io)) {
597 		rsnd_mod_write(mod, SSICR, cr | EN);
598 		rsnd_ssi_status_check(mod, DIRQ);
599 	}
600 
601 	/*
602 	 * disable SSI,
603 	 * and, wait idle state
604 	 */
605 	rsnd_mod_write(mod, SSICR, cr);	/* disabled all */
606 	rsnd_ssi_status_check(mod, IIRQ);
607 
608 	ssi->cr_en = 0;
609 
610 	return 0;
611 }
612 
613 static int rsnd_ssi_irq(struct rsnd_mod *mod,
614 			struct rsnd_dai_stream *io,
615 			struct rsnd_priv *priv,
616 			int enable)
617 {
618 	u32 val = 0;
619 
620 	if (rsnd_is_gen1(priv))
621 		return 0;
622 
623 	if (rsnd_ssi_is_parent(mod, io))
624 		return 0;
625 
626 	if (!rsnd_ssi_is_run_mods(mod, io))
627 		return 0;
628 
629 	if (enable)
630 		val = rsnd_ssi_is_dma_mode(mod) ? 0x0e000000 : 0x0f000000;
631 
632 	rsnd_mod_write(mod, SSI_INT_ENABLE, val);
633 
634 	return 0;
635 }
636 
637 static bool rsnd_ssi_pio_interrupt(struct rsnd_mod *mod,
638 				   struct rsnd_dai_stream *io);
639 static void __rsnd_ssi_interrupt(struct rsnd_mod *mod,
640 				 struct rsnd_dai_stream *io)
641 {
642 	struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
643 	struct device *dev = rsnd_priv_to_dev(priv);
644 	int is_dma = rsnd_ssi_is_dma_mode(mod);
645 	u32 status;
646 	bool elapsed = false;
647 	bool stop = false;
648 
649 	spin_lock(&priv->lock);
650 
651 	/* ignore all cases if not working */
652 	if (!rsnd_io_is_working(io))
653 		goto rsnd_ssi_interrupt_out;
654 
655 	status = rsnd_ssi_status_get(mod);
656 
657 	/* PIO only */
658 	if (!is_dma && (status & DIRQ))
659 		elapsed = rsnd_ssi_pio_interrupt(mod, io);
660 
661 	/* DMA only */
662 	if (is_dma && (status & (UIRQ | OIRQ))) {
663 		rsnd_dbg_irq_status(dev, "%s err status : 0x%08x\n",
664 			rsnd_mod_name(mod), status);
665 
666 		stop = true;
667 	}
668 
669 	rsnd_ssi_status_clear(mod);
670 rsnd_ssi_interrupt_out:
671 	spin_unlock(&priv->lock);
672 
673 	if (elapsed)
674 		rsnd_dai_period_elapsed(io);
675 
676 	if (stop)
677 		snd_pcm_stop_xrun(io->substream);
678 
679 }
680 
681 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
682 {
683 	struct rsnd_mod *mod = data;
684 
685 	rsnd_mod_interrupt(mod, __rsnd_ssi_interrupt);
686 
687 	return IRQ_HANDLED;
688 }
689 
690 static u32 *rsnd_ssi_get_status(struct rsnd_mod *mod,
691 				struct rsnd_dai_stream *io,
692 				enum rsnd_mod_type type)
693 {
694 	/*
695 	 * SSIP (= SSI parent) needs to be special, otherwise,
696 	 * 2nd SSI might doesn't start. see also rsnd_mod_call()
697 	 *
698 	 * We can't include parent SSI status on SSI, because we don't know
699 	 * how many SSI requests parent SSI. Thus, it is localed on "io" now.
700 	 * ex) trouble case
701 	 *	Playback: SSI0
702 	 *	Capture : SSI1 (needs SSI0)
703 	 *
704 	 * 1) start Capture  ->	SSI0/SSI1 are started.
705 	 * 2) start Playback ->	SSI0 doesn't work, because it is already
706 	 *			marked as "started" on 1)
707 	 *
708 	 * OTOH, using each mod's status is good for MUX case.
709 	 * It doesn't need to start in 2nd start
710 	 * ex)
711 	 *	IO-0: SRC0 -> CTU1 -+-> MUX -> DVC -> SSIU -> SSI0
712 	 *			    |
713 	 *	IO-1: SRC1 -> CTU2 -+
714 	 *
715 	 * 1) start IO-0 ->	start SSI0
716 	 * 2) start IO-1 ->	SSI0 doesn't need to start, because it is
717 	 *			already started on 1)
718 	 */
719 	if (type == RSND_MOD_SSIP)
720 		return &io->parent_ssi_status;
721 
722 	return rsnd_mod_get_status(mod, io, type);
723 }
724 
725 /*
726  *		SSI PIO
727  */
728 static void rsnd_ssi_parent_attach(struct rsnd_mod *mod,
729 				   struct rsnd_dai_stream *io)
730 {
731 	struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
732 	struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
733 
734 	if (!__rsnd_ssi_is_pin_sharing(mod))
735 		return;
736 
737 	if (!rsnd_rdai_is_clk_master(rdai))
738 		return;
739 
740 	switch (rsnd_mod_id(mod)) {
741 	case 1:
742 	case 2:
743 	case 9:
744 		rsnd_dai_connect(rsnd_ssi_mod_get(priv, 0), io, RSND_MOD_SSIP);
745 		break;
746 	case 4:
747 		rsnd_dai_connect(rsnd_ssi_mod_get(priv, 3), io, RSND_MOD_SSIP);
748 		break;
749 	case 8:
750 		rsnd_dai_connect(rsnd_ssi_mod_get(priv, 7), io, RSND_MOD_SSIP);
751 		break;
752 	}
753 }
754 
755 static int rsnd_ssi_pcm_new(struct rsnd_mod *mod,
756 			    struct rsnd_dai_stream *io,
757 			    struct snd_soc_pcm_runtime *rtd)
758 {
759 	/*
760 	 * rsnd_rdai_is_clk_master() will be enabled after set_fmt,
761 	 * and, pcm_new will be called after it.
762 	 * This function reuse pcm_new at this point.
763 	 */
764 	rsnd_ssi_parent_attach(mod, io);
765 
766 	return 0;
767 }
768 
769 static int rsnd_ssi_common_probe(struct rsnd_mod *mod,
770 				 struct rsnd_dai_stream *io,
771 				 struct rsnd_priv *priv)
772 {
773 	struct device *dev = rsnd_priv_to_dev(priv);
774 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
775 	int ret = 0;
776 
777 	/*
778 	 * SSIP/SSIU/IRQ are not needed on
779 	 * SSI Multi slaves
780 	 */
781 	if (rsnd_ssi_is_multi_slave(mod, io))
782 		return 0;
783 
784 	/*
785 	 * It can't judge ssi parent at this point
786 	 * see rsnd_ssi_pcm_new()
787 	 */
788 
789 	/*
790 	 * SSI might be called again as PIO fallback
791 	 * It is easy to manual handling for IRQ request/free
792 	 *
793 	 * OTOH, this function might be called many times if platform is
794 	 * using MIX. It needs xxx_attach() many times on xxx_probe().
795 	 * Because of it, we can't control .probe/.remove calling count by
796 	 * mod->status.
797 	 * But it don't need to call request_irq() many times.
798 	 * Let's control it by RSND_SSI_PROBED flag.
799 	 */
800 	if (!rsnd_flags_has(ssi, RSND_SSI_PROBED)) {
801 		ret = request_irq(ssi->irq,
802 				  rsnd_ssi_interrupt,
803 				  IRQF_SHARED,
804 				  dev_name(dev), mod);
805 
806 		rsnd_flags_set(ssi, RSND_SSI_PROBED);
807 	}
808 
809 	return ret;
810 }
811 
812 static int rsnd_ssi_common_remove(struct rsnd_mod *mod,
813 				  struct rsnd_dai_stream *io,
814 				  struct rsnd_priv *priv)
815 {
816 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
817 	struct rsnd_mod *pure_ssi_mod = rsnd_io_to_mod_ssi(io);
818 
819 	/* Do nothing if non SSI (= SSI parent, multi SSI) mod */
820 	if (pure_ssi_mod != mod)
821 		return 0;
822 
823 	/* PIO will request IRQ again */
824 	if (rsnd_flags_has(ssi, RSND_SSI_PROBED)) {
825 		free_irq(ssi->irq, mod);
826 
827 		rsnd_flags_del(ssi, RSND_SSI_PROBED);
828 	}
829 
830 	return 0;
831 }
832 
833 /*
834  *	SSI PIO functions
835  */
836 static bool rsnd_ssi_pio_interrupt(struct rsnd_mod *mod,
837 				   struct rsnd_dai_stream *io)
838 {
839 	struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
840 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
841 	u32 *buf = (u32 *)(runtime->dma_area + ssi->byte_pos);
842 	int shift = 0;
843 	int byte_pos;
844 	bool elapsed = false;
845 
846 	if (snd_pcm_format_width(runtime->format) == 24)
847 		shift = 8;
848 
849 	/*
850 	 * 8/16/32 data can be assesse to TDR/RDR register
851 	 * directly as 32bit data
852 	 * see rsnd_ssi_init()
853 	 */
854 	if (rsnd_io_is_play(io))
855 		rsnd_mod_write(mod, SSITDR, (*buf) << shift);
856 	else
857 		*buf = (rsnd_mod_read(mod, SSIRDR) >> shift);
858 
859 	byte_pos = ssi->byte_pos + sizeof(*buf);
860 
861 	if (byte_pos >= ssi->next_period_byte) {
862 		int period_pos = byte_pos / ssi->byte_per_period;
863 
864 		if (period_pos >= runtime->periods) {
865 			byte_pos = 0;
866 			period_pos = 0;
867 		}
868 
869 		ssi->next_period_byte = (period_pos + 1) * ssi->byte_per_period;
870 
871 		elapsed = true;
872 	}
873 
874 	WRITE_ONCE(ssi->byte_pos, byte_pos);
875 
876 	return elapsed;
877 }
878 
879 static int rsnd_ssi_pio_init(struct rsnd_mod *mod,
880 			     struct rsnd_dai_stream *io,
881 			     struct rsnd_priv *priv)
882 {
883 	struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
884 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
885 
886 	if (!rsnd_ssi_is_parent(mod, io)) {
887 		ssi->byte_pos		= 0;
888 		ssi->byte_per_period	= runtime->period_size *
889 					  runtime->channels *
890 					  samples_to_bytes(runtime, 1);
891 		ssi->next_period_byte	= ssi->byte_per_period;
892 	}
893 
894 	return rsnd_ssi_init(mod, io, priv);
895 }
896 
897 static int rsnd_ssi_pio_pointer(struct rsnd_mod *mod,
898 			    struct rsnd_dai_stream *io,
899 			    snd_pcm_uframes_t *pointer)
900 {
901 	struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
902 	struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
903 
904 	*pointer = bytes_to_frames(runtime, READ_ONCE(ssi->byte_pos));
905 
906 	return 0;
907 }
908 
909 static int rsnd_ssi_prepare(struct rsnd_mod *mod,
910 			    struct rsnd_dai_stream *io,
911 			    struct rsnd_priv *priv)
912 {
913 	return rsnd_ssi_master_clk_start(mod, io);
914 }
915 
916 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
917 	.name		= SSI_NAME,
918 	.probe		= rsnd_ssi_common_probe,
919 	.remove		= rsnd_ssi_common_remove,
920 	.init		= rsnd_ssi_pio_init,
921 	.quit		= rsnd_ssi_quit,
922 	.start		= rsnd_ssi_start,
923 	.stop		= rsnd_ssi_stop,
924 	.irq		= rsnd_ssi_irq,
925 	.pointer	= rsnd_ssi_pio_pointer,
926 	.pcm_new	= rsnd_ssi_pcm_new,
927 	.hw_params	= rsnd_ssi_hw_params,
928 	.prepare	= rsnd_ssi_prepare,
929 	.get_status	= rsnd_ssi_get_status,
930 };
931 
932 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
933 			      struct rsnd_dai_stream *io,
934 			      struct rsnd_priv *priv)
935 {
936 	int ret;
937 
938 	/*
939 	 * SSIP/SSIU/IRQ/DMA are not needed on
940 	 * SSI Multi slaves
941 	 */
942 	if (rsnd_ssi_is_multi_slave(mod, io))
943 		return 0;
944 
945 	ret = rsnd_ssi_common_probe(mod, io, priv);
946 	if (ret)
947 		return ret;
948 
949 	/* SSI probe might be called many times in MUX multi path */
950 	ret = rsnd_dma_attach(io, mod, &io->dma);
951 
952 	return ret;
953 }
954 
955 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
956 			     struct rsnd_dai_stream *io,
957 			     struct rsnd_priv *priv)
958 {
959 	struct device *dev = rsnd_priv_to_dev(priv);
960 
961 	/*
962 	 * fallback to PIO
963 	 *
964 	 * SSI .probe might be called again.
965 	 * see
966 	 *	rsnd_rdai_continuance_probe()
967 	 */
968 	mod->ops = &rsnd_ssi_pio_ops;
969 
970 	dev_info(dev, "%s fallback to PIO mode\n", rsnd_mod_name(mod));
971 
972 	return 0;
973 }
974 
975 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
976 					 struct rsnd_mod *mod)
977 {
978 	struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
979 	int is_play = rsnd_io_is_play(io);
980 	char *name;
981 
982 	/*
983 	 * It should use "rcar_sound,ssiu" on DT.
984 	 * But, we need to keep compatibility for old version.
985 	 *
986 	 * If it has "rcar_sound.ssiu", it will be used.
987 	 * If not, "rcar_sound.ssi" will be used.
988 	 * see
989 	 *	rsnd_ssiu_dma_req()
990 	 *	rsnd_dma_of_path()
991 	 */
992 
993 	if (rsnd_ssi_use_busif(io))
994 		name = is_play ? "rxu" : "txu";
995 	else
996 		name = is_play ? "rx" : "tx";
997 
998 	return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
999 					mod, name);
1000 }
1001 
1002 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
1003 	.name		= SSI_NAME,
1004 	.dma_req	= rsnd_ssi_dma_req,
1005 	.probe		= rsnd_ssi_dma_probe,
1006 	.remove		= rsnd_ssi_common_remove,
1007 	.init		= rsnd_ssi_init,
1008 	.quit		= rsnd_ssi_quit,
1009 	.start		= rsnd_ssi_start,
1010 	.stop		= rsnd_ssi_stop,
1011 	.irq		= rsnd_ssi_irq,
1012 	.pcm_new	= rsnd_ssi_pcm_new,
1013 	.fallback	= rsnd_ssi_fallback,
1014 	.hw_params	= rsnd_ssi_hw_params,
1015 	.prepare	= rsnd_ssi_prepare,
1016 	.get_status	= rsnd_ssi_get_status,
1017 };
1018 
1019 static int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
1020 {
1021 	return mod->ops == &rsnd_ssi_dma_ops;
1022 }
1023 
1024 /*
1025  *		ssi mod function
1026  */
1027 static void rsnd_ssi_connect(struct rsnd_mod *mod,
1028 			     struct rsnd_dai_stream *io)
1029 {
1030 	struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
1031 	enum rsnd_mod_type types[] = {
1032 		RSND_MOD_SSI,
1033 		RSND_MOD_SSIM1,
1034 		RSND_MOD_SSIM2,
1035 		RSND_MOD_SSIM3,
1036 	};
1037 	enum rsnd_mod_type type;
1038 	int i;
1039 
1040 	/* try SSI -> SSIM1 -> SSIM2 -> SSIM3 */
1041 	for (i = 0; i < ARRAY_SIZE(types); i++) {
1042 		type = types[i];
1043 		if (!rsnd_io_to_mod(io, type)) {
1044 			rsnd_dai_connect(mod, io, type);
1045 			rsnd_rdai_channels_set(rdai, (i + 1) * 2);
1046 			rsnd_rdai_ssi_lane_set(rdai, (i + 1));
1047 			return;
1048 		}
1049 	}
1050 }
1051 
1052 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
1053 			    struct device_node *playback,
1054 			    struct device_node *capture)
1055 {
1056 	struct rsnd_priv *priv = rsnd_rdai_to_priv(rdai);
1057 	struct device_node *node;
1058 	struct device_node *np;
1059 	struct rsnd_mod *mod;
1060 	int i;
1061 
1062 	node = rsnd_ssi_of_node(priv);
1063 	if (!node)
1064 		return;
1065 
1066 	i = 0;
1067 	for_each_child_of_node(node, np) {
1068 		mod = rsnd_ssi_mod_get(priv, i);
1069 		if (np == playback)
1070 			rsnd_ssi_connect(mod, &rdai->playback);
1071 		if (np == capture)
1072 			rsnd_ssi_connect(mod, &rdai->capture);
1073 		i++;
1074 	}
1075 
1076 	of_node_put(node);
1077 }
1078 
1079 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
1080 {
1081 	if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
1082 		id = 0;
1083 
1084 	return rsnd_mod_get(rsnd_ssi_get(priv, id));
1085 }
1086 
1087 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
1088 {
1089 	if (!mod)
1090 		return 0;
1091 
1092 	return !!(rsnd_flags_has(rsnd_mod_to_ssi(mod), RSND_SSI_CLK_PIN_SHARE));
1093 }
1094 
1095 int rsnd_ssi_probe(struct rsnd_priv *priv)
1096 {
1097 	struct device_node *node;
1098 	struct device_node *np;
1099 	struct device *dev = rsnd_priv_to_dev(priv);
1100 	struct rsnd_mod_ops *ops;
1101 	struct clk *clk;
1102 	struct rsnd_ssi *ssi;
1103 	char name[RSND_SSI_NAME_SIZE];
1104 	int i, nr, ret;
1105 
1106 	node = rsnd_ssi_of_node(priv);
1107 	if (!node)
1108 		return -EINVAL;
1109 
1110 	nr = of_get_child_count(node);
1111 	if (!nr) {
1112 		ret = -EINVAL;
1113 		goto rsnd_ssi_probe_done;
1114 	}
1115 
1116 	ssi	= devm_kcalloc(dev, nr, sizeof(*ssi), GFP_KERNEL);
1117 	if (!ssi) {
1118 		ret = -ENOMEM;
1119 		goto rsnd_ssi_probe_done;
1120 	}
1121 
1122 	priv->ssi	= ssi;
1123 	priv->ssi_nr	= nr;
1124 
1125 	i = 0;
1126 	for_each_child_of_node(node, np) {
1127 		if (!of_device_is_available(np))
1128 			goto skip;
1129 
1130 		ssi = rsnd_ssi_get(priv, i);
1131 
1132 		snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
1133 			 SSI_NAME, i);
1134 
1135 		clk = devm_clk_get(dev, name);
1136 		if (IS_ERR(clk)) {
1137 			ret = PTR_ERR(clk);
1138 			of_node_put(np);
1139 			goto rsnd_ssi_probe_done;
1140 		}
1141 
1142 		if (of_get_property(np, "shared-pin", NULL))
1143 			rsnd_flags_set(ssi, RSND_SSI_CLK_PIN_SHARE);
1144 
1145 		if (of_get_property(np, "no-busif", NULL))
1146 			rsnd_flags_set(ssi, RSND_SSI_NO_BUSIF);
1147 
1148 		ssi->irq = irq_of_parse_and_map(np, 0);
1149 		if (!ssi->irq) {
1150 			ret = -EINVAL;
1151 			of_node_put(np);
1152 			goto rsnd_ssi_probe_done;
1153 		}
1154 
1155 		if (of_property_read_bool(np, "pio-transfer"))
1156 			ops = &rsnd_ssi_pio_ops;
1157 		else
1158 			ops = &rsnd_ssi_dma_ops;
1159 
1160 		ret = rsnd_mod_init(priv, rsnd_mod_get(ssi), ops, clk,
1161 				    RSND_MOD_SSI, i);
1162 		if (ret) {
1163 			of_node_put(np);
1164 			goto rsnd_ssi_probe_done;
1165 		}
1166 skip:
1167 		i++;
1168 	}
1169 
1170 	ret = 0;
1171 
1172 rsnd_ssi_probe_done:
1173 	of_node_put(node);
1174 
1175 	return ret;
1176 }
1177 
1178 void rsnd_ssi_remove(struct rsnd_priv *priv)
1179 {
1180 	struct rsnd_ssi *ssi;
1181 	int i;
1182 
1183 	for_each_rsnd_ssi(ssi, priv, i) {
1184 		rsnd_mod_quit(rsnd_mod_get(ssi));
1185 	}
1186 }
1187