2 * Renesas R-Car SRU/SCU/SSIU/SSI support
4 * Copyright (C) 2013 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
8 * Kuninori Morimoto <morimoto.kuninori@renesas.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
16 * Renesas R-Car sound device structure
20 * SRU : Sound Routing Unit
21 * - SRC : Sampling Rate Converter
23 * - CTU : Channel Count Conversion Unit
25 * - DVC : Digital Volume and Mute Function
26 * - SSI : Serial Sound Interface
30 * SCU : Sampling Rate Converter Unit
31 * - SRC : Sampling Rate Converter
33 * - CTU : Channel Count Conversion Unit
35 * - DVC : Digital Volume and Mute Function
36 * SSIU : Serial Sound Interface Unit
37 * - SSI : Serial Sound Interface
45 * | ** this depends on Gen1/Gen2
49 * | ** these depend on data path
50 * | ** gen and platform data control it
54 * | +- playback -> [mod] -> [mod] -> [mod] -> ...
57 * | +- capture -> [mod] -> [mod] -> [mod] -> ...
61 * | +- playback -> [mod] -> [mod] -> [mod] -> ...
64 * | +- capture -> [mod] -> [mod] -> [mod] -> ...
67 * | ** these control ssi
76 * | ** these control scu
86 * for_each_rsnd_dai(xx, priv, xx)
87 * rdai[0] => rdai[1] => rdai[2] => ...
89 * for_each_rsnd_mod(xx, rdai, xx)
90 * [mod] => [mod] => [mod] => ...
92 * rsnd_dai_call(xxx, fn )
93 * [mod]->fn() -> [mod]->fn() -> [mod]->fn()...
96 #include <linux/pm_runtime.h>
97 #include <linux/shdma-base.h>
100 #define RSND_RATES SNDRV_PCM_RATE_8000_96000
101 #define RSND_FMTS (SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE)
104 * rsnd_platform functions
106 #define rsnd_platform_call(priv, dai, func, param...) \
107 (!(priv->info->func) ? 0 : \
108 priv->info->func(param))
113 char *rsnd_mod_name(struct rsnd_mod *mod)
115 if (!mod || !mod->ops)
118 return mod->ops->name;
121 void rsnd_mod_init(struct rsnd_priv *priv,
122 struct rsnd_mod *mod,
123 struct rsnd_mod_ops *ops,
129 INIT_LIST_HEAD(&mod->list);
135 static void rsnd_dma_continue(struct rsnd_dma *dma)
137 /* push next A or B plane */
138 dma->submit_loop = 1;
139 schedule_work(&dma->work);
142 void rsnd_dma_start(struct rsnd_dma *dma)
144 /* push both A and B plane*/
145 dma->submit_loop = 2;
146 schedule_work(&dma->work);
149 void rsnd_dma_stop(struct rsnd_dma *dma)
151 dma->submit_loop = 0;
152 cancel_work_sync(&dma->work);
153 dmaengine_terminate_all(dma->chan);
156 static void rsnd_dma_complete(void *data)
158 struct rsnd_dma *dma = (struct rsnd_dma *)data;
159 struct rsnd_priv *priv = rsnd_mod_to_priv(rsnd_dma_to_mod(dma));
162 rsnd_lock(priv, flags);
166 if (dma->submit_loop)
167 rsnd_dma_continue(dma);
169 rsnd_unlock(priv, flags);
172 static void rsnd_dma_do_work(struct work_struct *work)
174 struct rsnd_dma *dma = container_of(work, struct rsnd_dma, work);
175 struct rsnd_priv *priv = rsnd_mod_to_priv(rsnd_dma_to_mod(dma));
176 struct device *dev = rsnd_priv_to_dev(priv);
177 struct dma_async_tx_descriptor *desc;
182 for (i = 0; i < dma->submit_loop; i++) {
184 if (dma->inquiry(dma, &buf, &len) < 0)
187 desc = dmaengine_prep_slave_single(
188 dma->chan, buf, len, dma->dir,
189 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
191 dev_err(dev, "dmaengine_prep_slave_sg() fail\n");
195 desc->callback = rsnd_dma_complete;
196 desc->callback_param = dma;
198 if (dmaengine_submit(desc) < 0) {
199 dev_err(dev, "dmaengine_submit() fail\n");
203 dma_async_issue_pending(dma->chan);
207 int rsnd_dma_available(struct rsnd_dma *dma)
212 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
214 int (*inquiry)(struct rsnd_dma *dma,
215 dma_addr_t *buf, int *len),
216 int (*complete)(struct rsnd_dma *dma))
218 struct device *dev = rsnd_priv_to_dev(priv);
219 struct dma_slave_config cfg;
224 dev_err(dev, "it already has dma channel\n");
229 dma_cap_set(DMA_SLAVE, mask);
231 dma->chan = dma_request_slave_channel_compat(mask, shdma_chan_filter,
233 is_play ? "tx" : "rx");
235 dev_err(dev, "can't get dma channel\n");
240 cfg.dst_addr = 0; /* use default addr when playback */
241 cfg.src_addr = 0; /* use default addr when capture */
242 cfg.direction = is_play ? DMA_MEM_TO_DEV : DMA_DEV_TO_MEM;
244 ret = dmaengine_slave_config(dma->chan, &cfg);
246 goto rsnd_dma_init_err;
248 dma->dir = is_play ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
249 dma->inquiry = inquiry;
250 dma->complete = complete;
251 INIT_WORK(&dma->work, rsnd_dma_do_work);
256 rsnd_dma_quit(priv, dma);
261 void rsnd_dma_quit(struct rsnd_priv *priv,
262 struct rsnd_dma *dma)
265 dma_release_channel(dma->chan);
273 #define rsnd_dai_call(rdai, io, fn) \
275 struct rsnd_mod *mod, *n; \
277 for_each_rsnd_mod(mod, n, io) { \
278 ret = rsnd_mod_call(mod, fn, rdai, io); \
285 int rsnd_dai_connect(struct rsnd_dai *rdai,
286 struct rsnd_mod *mod,
287 struct rsnd_dai_stream *io)
292 if (!list_empty(&mod->list)) {
293 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
294 struct device *dev = rsnd_priv_to_dev(priv);
296 dev_err(dev, "%s%d is not empty\n",
302 list_add_tail(&mod->list, &io->head);
307 int rsnd_dai_disconnect(struct rsnd_mod *mod)
309 list_del_init(&mod->list);
314 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai)
316 int id = rdai - priv->rdai;
318 if ((id < 0) || (id >= rsnd_dai_nr(priv)))
324 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id)
326 if ((id < 0) || (id >= rsnd_dai_nr(priv)))
329 return priv->rdai + id;
332 static struct rsnd_dai *rsnd_dai_to_rdai(struct snd_soc_dai *dai)
334 struct rsnd_priv *priv = snd_soc_dai_get_drvdata(dai);
336 return rsnd_dai_get(priv, dai->id);
339 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io)
341 return &rdai->playback == io;
345 * rsnd_soc_dai functions
347 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional)
349 struct snd_pcm_substream *substream = io->substream;
350 struct snd_pcm_runtime *runtime = substream->runtime;
351 int pos = io->byte_pos + additional;
353 pos %= (runtime->periods * io->byte_per_period);
358 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int byte)
360 io->byte_pos += byte;
362 if (io->byte_pos >= io->next_period_byte) {
363 struct snd_pcm_substream *substream = io->substream;
364 struct snd_pcm_runtime *runtime = substream->runtime;
367 io->next_period_byte += io->byte_per_period;
369 if (io->period_pos >= runtime->periods) {
372 io->next_period_byte = io->byte_per_period;
375 snd_pcm_period_elapsed(substream);
379 static int rsnd_dai_stream_init(struct rsnd_dai_stream *io,
380 struct snd_pcm_substream *substream)
382 struct snd_pcm_runtime *runtime = substream->runtime;
384 if (!list_empty(&io->head))
387 INIT_LIST_HEAD(&io->head);
388 io->substream = substream;
391 io->byte_per_period = runtime->period_size *
393 samples_to_bytes(runtime, 1);
394 io->next_period_byte = io->byte_per_period;
400 struct snd_soc_dai *rsnd_substream_to_dai(struct snd_pcm_substream *substream)
402 struct snd_soc_pcm_runtime *rtd = substream->private_data;
408 struct rsnd_dai_stream *rsnd_rdai_to_io(struct rsnd_dai *rdai,
409 struct snd_pcm_substream *substream)
411 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
412 return &rdai->playback;
414 return &rdai->capture;
417 static int rsnd_soc_dai_trigger(struct snd_pcm_substream *substream, int cmd,
418 struct snd_soc_dai *dai)
420 struct rsnd_priv *priv = snd_soc_dai_get_drvdata(dai);
421 struct rsnd_dai *rdai = rsnd_dai_to_rdai(dai);
422 struct rsnd_dai_stream *io = rsnd_rdai_to_io(rdai, substream);
423 struct rsnd_mod *mod = rsnd_ssi_mod_get_frm_dai(priv,
424 rsnd_dai_id(priv, rdai),
425 rsnd_dai_is_play(rdai, io));
426 int ssi_id = rsnd_mod_id(mod);
430 rsnd_lock(priv, flags);
433 case SNDRV_PCM_TRIGGER_START:
434 ret = rsnd_dai_stream_init(io, substream);
436 goto dai_trigger_end;
438 ret = rsnd_platform_call(priv, dai, start, ssi_id);
440 goto dai_trigger_end;
442 ret = rsnd_gen_path_init(priv, rdai, io);
444 goto dai_trigger_end;
446 ret = rsnd_dai_call(rdai, io, init);
448 goto dai_trigger_end;
450 ret = rsnd_dai_call(rdai, io, start);
452 goto dai_trigger_end;
454 case SNDRV_PCM_TRIGGER_STOP:
455 ret = rsnd_dai_call(rdai, io, stop);
457 goto dai_trigger_end;
459 ret = rsnd_dai_call(rdai, io, quit);
461 goto dai_trigger_end;
463 ret = rsnd_gen_path_exit(priv, rdai, io);
465 goto dai_trigger_end;
467 ret = rsnd_platform_call(priv, dai, stop, ssi_id);
469 goto dai_trigger_end;
476 rsnd_unlock(priv, flags);
481 static int rsnd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
483 struct rsnd_dai *rdai = rsnd_dai_to_rdai(dai);
485 /* set master/slave audio interface */
486 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
487 case SND_SOC_DAIFMT_CBM_CFM:
488 rdai->clk_master = 1;
490 case SND_SOC_DAIFMT_CBS_CFS:
491 rdai->clk_master = 0;
497 /* set clock inversion */
498 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
499 case SND_SOC_DAIFMT_NB_IF:
500 rdai->bit_clk_inv = 0;
501 rdai->frm_clk_inv = 1;
503 case SND_SOC_DAIFMT_IB_NF:
504 rdai->bit_clk_inv = 1;
505 rdai->frm_clk_inv = 0;
507 case SND_SOC_DAIFMT_IB_IF:
508 rdai->bit_clk_inv = 1;
509 rdai->frm_clk_inv = 1;
511 case SND_SOC_DAIFMT_NB_NF:
513 rdai->bit_clk_inv = 0;
514 rdai->frm_clk_inv = 0;
519 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
520 case SND_SOC_DAIFMT_I2S:
522 rdai->data_alignment = 0;
524 case SND_SOC_DAIFMT_LEFT_J:
526 rdai->data_alignment = 0;
528 case SND_SOC_DAIFMT_RIGHT_J:
530 rdai->data_alignment = 1;
537 static const struct snd_soc_dai_ops rsnd_soc_dai_ops = {
538 .trigger = rsnd_soc_dai_trigger,
539 .set_fmt = rsnd_soc_dai_set_fmt,
542 static int rsnd_dai_probe(struct platform_device *pdev,
543 struct rcar_snd_info *info,
544 struct rsnd_priv *priv)
546 struct snd_soc_dai_driver *drv;
547 struct rsnd_dai *rdai;
548 struct rsnd_mod *pmod, *cmod;
549 struct device *dev = rsnd_priv_to_dev(priv);
554 for (dai_nr = 0; dai_nr < 32; dai_nr++) {
555 pmod = rsnd_ssi_mod_get_frm_dai(priv, dai_nr, 1);
556 cmod = rsnd_ssi_mod_get_frm_dai(priv, dai_nr, 0);
563 dev_err(dev, "no dai\n");
567 drv = devm_kzalloc(dev, sizeof(*drv) * dai_nr, GFP_KERNEL);
568 rdai = devm_kzalloc(dev, sizeof(*rdai) * dai_nr, GFP_KERNEL);
570 dev_err(dev, "dai allocate failed\n");
574 for (i = 0; i < dai_nr; i++) {
576 pmod = rsnd_ssi_mod_get_frm_dai(priv, i, 1);
577 cmod = rsnd_ssi_mod_get_frm_dai(priv, i, 0);
582 INIT_LIST_HEAD(&rdai[i].playback.head);
583 INIT_LIST_HEAD(&rdai[i].capture.head);
585 snprintf(rdai[i].name, RSND_DAI_NAME_SIZE, "rsnd-dai.%d", i);
588 * init snd_soc_dai_driver
590 drv[i].name = rdai[i].name;
591 drv[i].ops = &rsnd_soc_dai_ops;
593 drv[i].playback.rates = RSND_RATES;
594 drv[i].playback.formats = RSND_FMTS;
595 drv[i].playback.channels_min = 2;
596 drv[i].playback.channels_max = 2;
599 drv[i].capture.rates = RSND_RATES;
600 drv[i].capture.formats = RSND_FMTS;
601 drv[i].capture.channels_min = 2;
602 drv[i].capture.channels_max = 2;
605 dev_dbg(dev, "%s (%s/%s)\n", rdai[i].name,
606 pmod ? "play" : " -- ",
607 cmod ? "capture" : " -- ");
610 priv->dai_nr = dai_nr;
617 static void rsnd_dai_remove(struct platform_device *pdev,
618 struct rsnd_priv *priv)
625 static struct snd_pcm_hardware rsnd_pcm_hardware = {
626 .info = SNDRV_PCM_INFO_INTERLEAVED |
627 SNDRV_PCM_INFO_MMAP |
628 SNDRV_PCM_INFO_MMAP_VALID |
629 SNDRV_PCM_INFO_PAUSE,
630 .buffer_bytes_max = 64 * 1024,
631 .period_bytes_min = 32,
632 .period_bytes_max = 8192,
638 static int rsnd_pcm_open(struct snd_pcm_substream *substream)
640 struct snd_pcm_runtime *runtime = substream->runtime;
643 snd_soc_set_runtime_hwparams(substream, &rsnd_pcm_hardware);
645 ret = snd_pcm_hw_constraint_integer(runtime,
646 SNDRV_PCM_HW_PARAM_PERIODS);
651 static int rsnd_hw_params(struct snd_pcm_substream *substream,
652 struct snd_pcm_hw_params *hw_params)
654 return snd_pcm_lib_malloc_pages(substream,
655 params_buffer_bytes(hw_params));
658 static snd_pcm_uframes_t rsnd_pointer(struct snd_pcm_substream *substream)
660 struct snd_pcm_runtime *runtime = substream->runtime;
661 struct snd_soc_dai *dai = rsnd_substream_to_dai(substream);
662 struct rsnd_dai *rdai = rsnd_dai_to_rdai(dai);
663 struct rsnd_dai_stream *io = rsnd_rdai_to_io(rdai, substream);
665 return bytes_to_frames(runtime, io->byte_pos);
668 static struct snd_pcm_ops rsnd_pcm_ops = {
669 .open = rsnd_pcm_open,
670 .ioctl = snd_pcm_lib_ioctl,
671 .hw_params = rsnd_hw_params,
672 .hw_free = snd_pcm_lib_free_pages,
673 .pointer = rsnd_pointer,
680 #define PREALLOC_BUFFER (32 * 1024)
681 #define PREALLOC_BUFFER_MAX (32 * 1024)
683 static int rsnd_pcm_new(struct snd_soc_pcm_runtime *rtd)
685 return snd_pcm_lib_preallocate_pages_for_all(
688 rtd->card->snd_card->dev,
689 PREALLOC_BUFFER, PREALLOC_BUFFER_MAX);
692 static void rsnd_pcm_free(struct snd_pcm *pcm)
694 snd_pcm_lib_preallocate_free_for_all(pcm);
697 static struct snd_soc_platform_driver rsnd_soc_platform = {
698 .ops = &rsnd_pcm_ops,
699 .pcm_new = rsnd_pcm_new,
700 .pcm_free = rsnd_pcm_free,
703 static const struct snd_soc_component_driver rsnd_soc_component = {
710 static int rsnd_probe(struct platform_device *pdev)
712 struct rcar_snd_info *info;
713 struct rsnd_priv *priv;
714 struct device *dev = &pdev->dev;
717 info = pdev->dev.platform_data;
719 dev_err(dev, "driver needs R-Car sound information\n");
726 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
728 dev_err(dev, "priv allocate failed\n");
734 spin_lock_init(&priv->lock);
739 ret = rsnd_gen_probe(pdev, info, priv);
743 ret = rsnd_scu_probe(pdev, info, priv);
747 ret = rsnd_adg_probe(pdev, info, priv);
751 ret = rsnd_ssi_probe(pdev, info, priv);
755 ret = rsnd_dai_probe(pdev, info, priv);
762 ret = snd_soc_register_platform(dev, &rsnd_soc_platform);
764 dev_err(dev, "cannot snd soc register\n");
768 ret = snd_soc_register_component(dev, &rsnd_soc_component,
769 priv->daidrv, rsnd_dai_nr(priv));
771 dev_err(dev, "cannot snd dai register\n");
775 dev_set_drvdata(dev, priv);
777 pm_runtime_enable(dev);
779 dev_info(dev, "probed\n");
783 snd_soc_unregister_platform(dev);
788 static int rsnd_remove(struct platform_device *pdev)
790 struct rsnd_priv *priv = dev_get_drvdata(&pdev->dev);
792 pm_runtime_disable(&pdev->dev);
797 rsnd_ssi_remove(pdev, priv);
798 rsnd_adg_remove(pdev, priv);
799 rsnd_scu_remove(pdev, priv);
800 rsnd_dai_remove(pdev, priv);
801 rsnd_gen_remove(pdev, priv);
806 static struct platform_driver rsnd_driver = {
808 .name = "rcar_sound",
811 .remove = rsnd_remove,
813 module_platform_driver(rsnd_driver);
815 MODULE_LICENSE("GPL");
816 MODULE_DESCRIPTION("Renesas R-Car audio driver");
817 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
818 MODULE_ALIAS("platform:rcar-pcm-audio");