xref: /openbmc/linux/sound/soc/sh/rcar/src.c (revision f3a8b664)
1 /*
2  * Renesas R-Car SRC support
3  *
4  * Copyright (C) 2013 Renesas Solutions Corp.
5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11 #include "rsnd.h"
12 
13 #define SRC_NAME "src"
14 
15 /* SRCx_STATUS */
16 #define OUF_SRCO	((1 << 12) | (1 << 13))
17 #define OUF_SRCI	((1 <<  9) | (1 <<  8))
18 
19 /* SCU_SYSTEM_STATUS0/1 */
20 #define OUF_SRC(id)	((1 << (id + 16)) | (1 << id))
21 
22 struct rsnd_src {
23 	struct rsnd_mod mod;
24 	struct rsnd_mod *dma;
25 	struct rsnd_kctrl_cfg_s sen;  /* sync convert enable */
26 	struct rsnd_kctrl_cfg_s sync; /* sync convert */
27 	u32 convert_rate; /* sampling rate convert */
28 	int irq;
29 };
30 
31 #define RSND_SRC_NAME_SIZE 16
32 
33 #define rsnd_src_get(priv, id) ((struct rsnd_src *)(priv->src) + id)
34 #define rsnd_src_to_dma(src) ((src)->dma)
35 #define rsnd_src_nr(priv) ((priv)->src_nr)
36 #define rsnd_src_sync_is_enabled(mod) (rsnd_mod_to_src(mod)->sen.val)
37 
38 #define rsnd_mod_to_src(_mod)				\
39 	container_of((_mod), struct rsnd_src, mod)
40 
41 #define for_each_rsnd_src(pos, priv, i)				\
42 	for ((i) = 0;						\
43 	     ((i) < rsnd_src_nr(priv)) &&			\
44 	     ((pos) = (struct rsnd_src *)(priv)->src + i);	\
45 	     i++)
46 
47 
48 /*
49  *		image of SRC (Sampling Rate Converter)
50  *
51  * 96kHz   <-> +-----+	48kHz	+-----+	 48kHz	+-------+
52  * 48kHz   <-> | SRC | <------>	| SSI |	<----->	| codec |
53  * 44.1kHz <-> +-----+		+-----+		+-------+
54  * ...
55  *
56  */
57 
58 /*
59  * src.c is caring...
60  *
61  * Gen1
62  *
63  * [mem] -> [SRU] -> [SSI]
64  *        |--------|
65  *
66  * Gen2
67  *
68  * [mem] -> [SRC] -> [SSIU] -> [SSI]
69  *        |-----------------|
70  */
71 
72 static void rsnd_src_activation(struct rsnd_mod *mod)
73 {
74 	rsnd_mod_write(mod, SRC_SWRSR, 0);
75 	rsnd_mod_write(mod, SRC_SWRSR, 1);
76 }
77 
78 static void rsnd_src_halt(struct rsnd_mod *mod)
79 {
80 	rsnd_mod_write(mod, SRC_SRCIR, 1);
81 	rsnd_mod_write(mod, SRC_SWRSR, 0);
82 }
83 
84 static struct dma_chan *rsnd_src_dma_req(struct rsnd_dai_stream *io,
85 					 struct rsnd_mod *mod)
86 {
87 	struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
88 	int is_play = rsnd_io_is_play(io);
89 
90 	return rsnd_dma_request_channel(rsnd_src_of_node(priv),
91 					mod,
92 					is_play ? "rx" : "tx");
93 }
94 
95 static u32 rsnd_src_convert_rate(struct rsnd_dai_stream *io,
96 				 struct rsnd_mod *mod)
97 {
98 	struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
99 	struct rsnd_src *src = rsnd_mod_to_src(mod);
100 	u32 convert_rate;
101 
102 	if (!runtime)
103 		return 0;
104 
105 	if (!rsnd_src_sync_is_enabled(mod))
106 		return src->convert_rate;
107 
108 	convert_rate = src->sync.val;
109 
110 	if (!convert_rate)
111 		convert_rate = src->convert_rate;
112 
113 	if (!convert_rate)
114 		convert_rate = runtime->rate;
115 
116 	return convert_rate;
117 }
118 
119 unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
120 			       struct rsnd_dai_stream *io,
121 			       int is_in)
122 {
123 	struct rsnd_mod *src_mod = rsnd_io_to_mod_src(io);
124 	struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
125 	unsigned int rate = 0;
126 	int is_play = rsnd_io_is_play(io);
127 
128 	/*
129 	 *
130 	 * Playback
131 	 * runtime_rate -> [SRC] -> convert_rate
132 	 *
133 	 * Capture
134 	 * convert_rate -> [SRC] -> runtime_rate
135 	 */
136 
137 	if (is_play == is_in)
138 		return runtime->rate;
139 
140 	/*
141 	 * return convert rate if SRC is used,
142 	 * otherwise, return runtime->rate as usual
143 	 */
144 	if (src_mod)
145 		rate = rsnd_src_convert_rate(io, src_mod);
146 
147 	if (!rate)
148 		rate = runtime->rate;
149 
150 	return rate;
151 }
152 
153 static int rsnd_src_hw_params(struct rsnd_mod *mod,
154 			      struct rsnd_dai_stream *io,
155 			      struct snd_pcm_substream *substream,
156 			      struct snd_pcm_hw_params *fe_params)
157 {
158 	struct rsnd_src *src = rsnd_mod_to_src(mod);
159 	struct snd_soc_pcm_runtime *fe = substream->private_data;
160 
161 	/*
162 	 * SRC assumes that it is used under DPCM if user want to use
163 	 * sampling rate convert. Then, SRC should be FE.
164 	 * And then, this function will be called *after* BE settings.
165 	 * this means, each BE already has fixuped hw_params.
166 	 * see
167 	 *	dpcm_fe_dai_hw_params()
168 	 *	dpcm_be_dai_hw_params()
169 	 */
170 	if (fe->dai_link->dynamic) {
171 		int stream = substream->stream;
172 		struct snd_soc_dpcm *dpcm;
173 		struct snd_pcm_hw_params *be_params;
174 
175 		list_for_each_entry(dpcm, &fe->dpcm[stream].be_clients, list_be) {
176 			be_params = &dpcm->hw_params;
177 
178 			if (params_rate(fe_params) != params_rate(be_params))
179 				src->convert_rate = params_rate(be_params);
180 		}
181 	}
182 
183 	return 0;
184 }
185 
186 static void rsnd_src_set_convert_rate(struct rsnd_dai_stream *io,
187 				      struct rsnd_mod *mod)
188 {
189 	struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
190 	struct device *dev = rsnd_priv_to_dev(priv);
191 	struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
192 	u32 fin, fout;
193 	u32 ifscr, fsrate, adinr;
194 	u32 cr, route;
195 	u32 bsdsr, bsisr;
196 	uint ratio;
197 
198 	if (!runtime)
199 		return;
200 
201 	fin  = rsnd_src_get_in_rate(priv, io);
202 	fout = rsnd_src_get_out_rate(priv, io);
203 
204 	/* 6 - 1/6 are very enough ratio for SRC_BSDSR */
205 	if (fin == fout)
206 		ratio = 0;
207 	else if (fin > fout)
208 		ratio = 100 * fin / fout;
209 	else
210 		ratio = 100 * fout / fin;
211 
212 	if (ratio > 600) {
213 		dev_err(dev, "FSO/FSI ratio error\n");
214 		return;
215 	}
216 
217 	/*
218 	 *	SRC_ADINR
219 	 */
220 	adinr = rsnd_get_adinr_bit(mod, io) |
221 		rsnd_runtime_channel_original(io);
222 
223 	/*
224 	 *	SRC_IFSCR / SRC_IFSVR
225 	 */
226 	ifscr = 0;
227 	fsrate = 0;
228 	if (fin != fout) {
229 		u64 n;
230 
231 		ifscr = 1;
232 		n = (u64)0x0400000 * fin;
233 		do_div(n, fout);
234 		fsrate = n;
235 	}
236 
237 	/*
238 	 *	SRC_SRCCR / SRC_ROUTE_MODE0
239 	 */
240 	cr	= 0x00011110;
241 	route	= 0x0;
242 	if (fin != fout) {
243 		route	= 0x1;
244 
245 		if (rsnd_src_sync_is_enabled(mod)) {
246 			cr |= 0x1;
247 			route |= rsnd_io_is_play(io) ?
248 				(0x1 << 24) : (0x1 << 25);
249 		}
250 	}
251 
252 	/*
253 	 * SRC_BSDSR / SRC_BSISR
254 	 */
255 	switch (rsnd_mod_id(mod)) {
256 	case 5:
257 	case 6:
258 	case 7:
259 	case 8:
260 		bsdsr = 0x02400000; /* 6 - 1/6 */
261 		bsisr = 0x00100060; /* 6 - 1/6 */
262 		break;
263 	default:
264 		bsdsr = 0x01800000; /* 6 - 1/6 */
265 		bsisr = 0x00100060 ;/* 6 - 1/6 */
266 		break;
267 	}
268 
269 	rsnd_mod_write(mod, SRC_ROUTE_MODE0, route);
270 
271 	rsnd_mod_write(mod, SRC_SRCIR, 1);	/* initialize */
272 	rsnd_mod_write(mod, SRC_ADINR, adinr);
273 	rsnd_mod_write(mod, SRC_IFSCR, ifscr);
274 	rsnd_mod_write(mod, SRC_IFSVR, fsrate);
275 	rsnd_mod_write(mod, SRC_SRCCR, cr);
276 	rsnd_mod_write(mod, SRC_BSDSR, bsdsr);
277 	rsnd_mod_write(mod, SRC_BSISR, bsisr);
278 	rsnd_mod_write(mod, SRC_SRCIR, 0);	/* cancel initialize */
279 
280 	rsnd_mod_write(mod, SRC_I_BUSIF_MODE, 1);
281 	rsnd_mod_write(mod, SRC_O_BUSIF_MODE, 1);
282 	rsnd_mod_write(mod, SRC_BUSIF_DALIGN, rsnd_get_dalign(mod, io));
283 
284 	rsnd_adg_set_src_timesel_gen2(mod, io, fin, fout);
285 }
286 
287 static int rsnd_src_irq(struct rsnd_mod *mod,
288 			struct rsnd_dai_stream *io,
289 			struct rsnd_priv *priv,
290 			int enable)
291 {
292 	struct rsnd_src *src = rsnd_mod_to_src(mod);
293 	u32 sys_int_val, int_val, sys_int_mask;
294 	int irq = src->irq;
295 	int id = rsnd_mod_id(mod);
296 
297 	sys_int_val =
298 	sys_int_mask = OUF_SRC(id);
299 	int_val = 0x3300;
300 
301 	/*
302 	 * IRQ is not supported on non-DT
303 	 * see
304 	 *	rsnd_src_probe_()
305 	 */
306 	if ((irq <= 0) || !enable) {
307 		sys_int_val = 0;
308 		int_val = 0;
309 	}
310 
311 	/*
312 	 * WORKAROUND
313 	 *
314 	 * ignore over flow error when rsnd_src_sync_is_enabled()
315 	 */
316 	if (rsnd_src_sync_is_enabled(mod))
317 		sys_int_val = sys_int_val & 0xffff;
318 
319 	rsnd_mod_write(mod, SRC_INT_ENABLE0, int_val);
320 	rsnd_mod_bset(mod, SCU_SYS_INT_EN0, sys_int_mask, sys_int_val);
321 	rsnd_mod_bset(mod, SCU_SYS_INT_EN1, sys_int_mask, sys_int_val);
322 
323 	return 0;
324 }
325 
326 static void rsnd_src_status_clear(struct rsnd_mod *mod)
327 {
328 	u32 val = OUF_SRC(rsnd_mod_id(mod));
329 
330 	rsnd_mod_bset(mod, SCU_SYS_STATUS0, val, val);
331 	rsnd_mod_bset(mod, SCU_SYS_STATUS1, val, val);
332 }
333 
334 static bool rsnd_src_error_occurred(struct rsnd_mod *mod)
335 {
336 	u32 val0, val1;
337 	bool ret = false;
338 
339 	val0 = val1 = OUF_SRC(rsnd_mod_id(mod));
340 
341 	/*
342 	 * WORKAROUND
343 	 *
344 	 * ignore over flow error when rsnd_src_sync_is_enabled()
345 	 */
346 	if (rsnd_src_sync_is_enabled(mod))
347 		val0 = val0 & 0xffff;
348 
349 	if ((rsnd_mod_read(mod, SCU_SYS_STATUS0) & val0) ||
350 	    (rsnd_mod_read(mod, SCU_SYS_STATUS1) & val1))
351 		ret = true;
352 
353 	return ret;
354 }
355 
356 static int rsnd_src_start(struct rsnd_mod *mod,
357 			  struct rsnd_dai_stream *io,
358 			  struct rsnd_priv *priv)
359 {
360 	u32 val;
361 
362 	/*
363 	 * WORKAROUND
364 	 *
365 	 * Enable SRC output if you want to use sync convert together with DVC
366 	 */
367 	val = (rsnd_io_to_mod_dvc(io) && !rsnd_src_sync_is_enabled(mod)) ?
368 		0x01 : 0x11;
369 
370 	rsnd_mod_write(mod, SRC_CTRL, val);
371 
372 	return 0;
373 }
374 
375 static int rsnd_src_stop(struct rsnd_mod *mod,
376 			 struct rsnd_dai_stream *io,
377 			 struct rsnd_priv *priv)
378 {
379 	rsnd_mod_write(mod, SRC_CTRL, 0);
380 
381 	return 0;
382 }
383 
384 static int rsnd_src_init(struct rsnd_mod *mod,
385 			 struct rsnd_dai_stream *io,
386 			 struct rsnd_priv *priv)
387 {
388 	struct rsnd_src *src = rsnd_mod_to_src(mod);
389 
390 	rsnd_mod_power_on(mod);
391 
392 	rsnd_src_activation(mod);
393 
394 	rsnd_src_set_convert_rate(io, mod);
395 
396 	rsnd_src_status_clear(mod);
397 
398 	/* reset sync convert_rate */
399 	src->sync.val = 0;
400 
401 	return 0;
402 }
403 
404 static int rsnd_src_quit(struct rsnd_mod *mod,
405 			 struct rsnd_dai_stream *io,
406 			 struct rsnd_priv *priv)
407 {
408 	struct rsnd_src *src = rsnd_mod_to_src(mod);
409 
410 	rsnd_src_halt(mod);
411 
412 	rsnd_mod_power_off(mod);
413 
414 	src->convert_rate = 0;
415 
416 	/* reset sync convert_rate */
417 	src->sync.val = 0;
418 
419 	return 0;
420 }
421 
422 static void __rsnd_src_interrupt(struct rsnd_mod *mod,
423 				 struct rsnd_dai_stream *io)
424 {
425 	struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
426 	bool stop = false;
427 
428 	spin_lock(&priv->lock);
429 
430 	/* ignore all cases if not working */
431 	if (!rsnd_io_is_working(io))
432 		goto rsnd_src_interrupt_out;
433 
434 	if (rsnd_src_error_occurred(mod))
435 		stop = true;
436 
437 	rsnd_src_status_clear(mod);
438 rsnd_src_interrupt_out:
439 
440 	spin_unlock(&priv->lock);
441 
442 	if (stop)
443 		snd_pcm_stop_xrun(io->substream);
444 }
445 
446 static irqreturn_t rsnd_src_interrupt(int irq, void *data)
447 {
448 	struct rsnd_mod *mod = data;
449 
450 	rsnd_mod_interrupt(mod, __rsnd_src_interrupt);
451 
452 	return IRQ_HANDLED;
453 }
454 
455 static int rsnd_src_probe_(struct rsnd_mod *mod,
456 			   struct rsnd_dai_stream *io,
457 			   struct rsnd_priv *priv)
458 {
459 	struct rsnd_src *src = rsnd_mod_to_src(mod);
460 	struct device *dev = rsnd_priv_to_dev(priv);
461 	int irq = src->irq;
462 	int ret;
463 
464 	if (irq > 0) {
465 		/*
466 		 * IRQ is not supported on non-DT
467 		 * see
468 		 *	rsnd_src_irq()
469 		 */
470 		ret = devm_request_irq(dev, irq,
471 				       rsnd_src_interrupt,
472 				       IRQF_SHARED,
473 				       dev_name(dev), mod);
474 		if (ret)
475 			return ret;
476 	}
477 
478 	ret = rsnd_dma_attach(io, mod, &src->dma, 0);
479 
480 	return ret;
481 }
482 
483 static int rsnd_src_pcm_new(struct rsnd_mod *mod,
484 			    struct rsnd_dai_stream *io,
485 			    struct snd_soc_pcm_runtime *rtd)
486 {
487 	struct rsnd_src *src = rsnd_mod_to_src(mod);
488 	int ret;
489 
490 	/*
491 	 * enable SRC sync convert if possible
492 	 */
493 
494 	/*
495 	 * It can't use SRC Synchronous convert
496 	 * when Capture if it uses CMD
497 	 */
498 	if (rsnd_io_to_mod_cmd(io) && !rsnd_io_is_play(io))
499 		return 0;
500 
501 	/*
502 	 * enable sync convert
503 	 */
504 	ret = rsnd_kctrl_new_s(mod, io, rtd,
505 			       rsnd_io_is_play(io) ?
506 			       "SRC Out Rate Switch" :
507 			       "SRC In Rate Switch",
508 			       rsnd_src_set_convert_rate,
509 			       &src->sen, 1);
510 	if (ret < 0)
511 		return ret;
512 
513 	ret = rsnd_kctrl_new_s(mod, io, rtd,
514 			       rsnd_io_is_play(io) ?
515 			       "SRC Out Rate" :
516 			       "SRC In Rate",
517 			       rsnd_src_set_convert_rate,
518 			       &src->sync, 192000);
519 
520 	return ret;
521 }
522 
523 static struct rsnd_mod_ops rsnd_src_ops = {
524 	.name	= SRC_NAME,
525 	.dma_req = rsnd_src_dma_req,
526 	.probe	= rsnd_src_probe_,
527 	.init	= rsnd_src_init,
528 	.quit	= rsnd_src_quit,
529 	.start	= rsnd_src_start,
530 	.stop	= rsnd_src_stop,
531 	.irq	= rsnd_src_irq,
532 	.hw_params = rsnd_src_hw_params,
533 	.pcm_new = rsnd_src_pcm_new,
534 };
535 
536 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id)
537 {
538 	if (WARN_ON(id < 0 || id >= rsnd_src_nr(priv)))
539 		id = 0;
540 
541 	return rsnd_mod_get(rsnd_src_get(priv, id));
542 }
543 
544 int rsnd_src_probe(struct rsnd_priv *priv)
545 {
546 	struct device_node *node;
547 	struct device_node *np;
548 	struct device *dev = rsnd_priv_to_dev(priv);
549 	struct rsnd_src *src;
550 	struct clk *clk;
551 	char name[RSND_SRC_NAME_SIZE];
552 	int i, nr, ret;
553 
554 	/* This driver doesn't support Gen1 at this point */
555 	if (rsnd_is_gen1(priv))
556 		return 0;
557 
558 	node = rsnd_src_of_node(priv);
559 	if (!node)
560 		return 0; /* not used is not error */
561 
562 	nr = of_get_child_count(node);
563 	if (!nr) {
564 		ret = -EINVAL;
565 		goto rsnd_src_probe_done;
566 	}
567 
568 	src	= devm_kzalloc(dev, sizeof(*src) * nr, GFP_KERNEL);
569 	if (!src) {
570 		ret = -ENOMEM;
571 		goto rsnd_src_probe_done;
572 	}
573 
574 	priv->src_nr	= nr;
575 	priv->src	= src;
576 
577 	i = 0;
578 	for_each_child_of_node(node, np) {
579 		if (!of_device_is_available(np))
580 			goto skip;
581 
582 		src = rsnd_src_get(priv, i);
583 
584 		snprintf(name, RSND_SRC_NAME_SIZE, "%s.%d",
585 			 SRC_NAME, i);
586 
587 		src->irq = irq_of_parse_and_map(np, 0);
588 		if (!src->irq) {
589 			ret = -EINVAL;
590 			goto rsnd_src_probe_done;
591 		}
592 
593 		clk = devm_clk_get(dev, name);
594 		if (IS_ERR(clk)) {
595 			ret = PTR_ERR(clk);
596 			goto rsnd_src_probe_done;
597 		}
598 
599 		ret = rsnd_mod_init(priv, rsnd_mod_get(src),
600 				    &rsnd_src_ops, clk, rsnd_mod_get_status,
601 				    RSND_MOD_SRC, i);
602 		if (ret)
603 			goto rsnd_src_probe_done;
604 
605 skip:
606 		i++;
607 	}
608 
609 	ret = 0;
610 
611 rsnd_src_probe_done:
612 	of_node_put(node);
613 
614 	return ret;
615 }
616 
617 void rsnd_src_remove(struct rsnd_priv *priv)
618 {
619 	struct rsnd_src *src;
620 	int i;
621 
622 	for_each_rsnd_src(src, priv, i) {
623 		rsnd_mod_quit(rsnd_mod_get(src));
624 	}
625 }
626