1 // SPDX-License-Identifier: GPL-2.0
3 // Socionext UniPhier AIO ALSA CPU DAI driver.
5 // Copyright (c) 2016-2018 Socionext Inc.
8 #include <linux/errno.h>
9 #include <linux/kernel.h>
10 #include <linux/mfd/syscon.h>
11 #include <linux/module.h>
13 #include <linux/of_platform.h>
14 #include <linux/platform_device.h>
15 #include <linux/reset.h>
16 #include <sound/core.h>
17 #include <sound/pcm.h>
18 #include <sound/pcm_params.h>
19 #include <sound/soc.h>
23 static bool is_valid_pll(struct uniphier_aio_chip *chip, int pll_id)
25 struct device *dev = &chip->pdev->dev;
27 if (pll_id < 0 || chip->num_plls <= pll_id) {
28 dev_err(dev, "PLL(%d) is not supported\n", pll_id);
32 return chip->plls[pll_id].enable;
36 * find_volume - find volume supported HW port by HW port number
37 * @chip: the AIO chip pointer
38 * @oport_hw: HW port number, one of AUD_HW_XXXX
40 * Find AIO device from device list by HW port number. Volume feature is
41 * available only in Output and PCM ports, this limitation comes from HW
44 * Return: The pointer of AIO substream if successful, otherwise NULL on error.
46 static struct uniphier_aio_sub *find_volume(struct uniphier_aio_chip *chip,
51 for (i = 0; i < chip->num_aios; i++) {
52 struct uniphier_aio_sub *sub = &chip->aios[i].sub[0];
57 if (sub->swm->oport.hw == oport_hw)
64 static bool match_spec(const struct uniphier_aio_spec *spec,
65 const char *name, int dir)
67 if (dir == SNDRV_PCM_STREAM_PLAYBACK &&
68 spec->swm.dir != PORT_DIR_OUTPUT) {
72 if (dir == SNDRV_PCM_STREAM_CAPTURE &&
73 spec->swm.dir != PORT_DIR_INPUT) {
77 if (spec->name && strcmp(spec->name, name) == 0)
80 if (spec->gname && strcmp(spec->gname, name) == 0)
87 * find_spec - find HW specification info by name
88 * @aio: the AIO device pointer
89 * @name: name of device
90 * @direction: the direction of substream, SNDRV_PCM_STREAM_*
92 * Find hardware specification information from list by device name. This
93 * information is used for telling the difference of SoCs to driver.
95 * Specification list is array of 'struct uniphier_aio_spec' which is defined
96 * in each drivers (see: aio-i2s.c).
98 * Return: The pointer of hardware specification of AIO if successful,
99 * otherwise NULL on error.
101 static const struct uniphier_aio_spec *find_spec(struct uniphier_aio *aio,
105 const struct uniphier_aio_chip_spec *chip_spec = aio->chip->chip_spec;
108 for (i = 0; i < chip_spec->num_specs; i++) {
109 const struct uniphier_aio_spec *spec = &chip_spec->specs[i];
111 if (match_spec(spec, name, direction))
119 * find_divider - find clock divider by frequency
120 * @aio: the AIO device pointer
121 * @pll_id: PLL ID, should be AUD_PLL_XX
122 * @freq: required frequency
124 * Find suitable clock divider by frequency.
126 * Return: The ID of PLL if successful, otherwise negative error value.
128 static int find_divider(struct uniphier_aio *aio, int pll_id, unsigned int freq)
130 struct uniphier_aio_pll *pll;
131 static const int mul[] = { 1, 1, 1, 2, };
132 static const int div[] = { 2, 3, 1, 3, };
135 if (!is_valid_pll(aio->chip, pll_id))
138 pll = &aio->chip->plls[pll_id];
139 for (i = 0; i < ARRAY_SIZE(mul); i++)
140 if (pll->freq * mul[i] / div[i] == freq)
146 static int uniphier_aio_set_sysclk(struct snd_soc_dai *dai, int clk_id,
147 unsigned int freq, int dir)
149 struct uniphier_aio *aio = uniphier_priv(dai);
150 struct device *dev = &aio->chip->pdev->dev;
151 bool pll_auto = false;
178 pll_id = AUD_PLL_APLL;
181 pll_id = AUD_PLL_RX0;
184 pll_id = AUD_PLL_USB0;
187 pll_id = AUD_PLL_HSC0;
190 dev_err(dev, "Sysclk(%d) is not supported\n", clk_id);
195 for (pll_id = 0; pll_id < aio->chip->num_plls; pll_id++) {
196 div_id = find_divider(aio, pll_id, freq);
198 aio->plldiv = div_id;
202 if (pll_id == aio->chip->num_plls) {
203 dev_err(dev, "Sysclk frequency is not supported(%d)\n",
209 if (dir == SND_SOC_CLOCK_OUT)
210 aio->pll_out = pll_id;
212 aio->pll_in = pll_id;
217 static int uniphier_aio_set_pll(struct snd_soc_dai *dai, int pll_id,
218 int source, unsigned int freq_in,
219 unsigned int freq_out)
221 struct uniphier_aio *aio = uniphier_priv(dai);
224 if (!is_valid_pll(aio->chip, pll_id))
227 ret = aio_chip_set_pll(aio->chip, pll_id, freq_out);
234 static int uniphier_aio_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
236 struct uniphier_aio *aio = uniphier_priv(dai);
237 struct device *dev = &aio->chip->pdev->dev;
239 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
240 case SND_SOC_DAIFMT_LEFT_J:
241 case SND_SOC_DAIFMT_RIGHT_J:
242 case SND_SOC_DAIFMT_I2S:
243 aio->fmt = fmt & SND_SOC_DAIFMT_FORMAT_MASK;
246 dev_err(dev, "Format is not supported(%d)\n",
247 fmt & SND_SOC_DAIFMT_FORMAT_MASK);
254 static int uniphier_aio_startup(struct snd_pcm_substream *substream,
255 struct snd_soc_dai *dai)
257 struct uniphier_aio *aio = uniphier_priv(dai);
258 struct uniphier_aio_sub *sub = &aio->sub[substream->stream];
260 sub->substream = substream;
261 sub->pass_through = 0;
262 sub->use_mmap = true;
264 return aio_init(sub);
267 static void uniphier_aio_shutdown(struct snd_pcm_substream *substream,
268 struct snd_soc_dai *dai)
270 struct uniphier_aio *aio = uniphier_priv(dai);
271 struct uniphier_aio_sub *sub = &aio->sub[substream->stream];
273 sub->substream = NULL;
276 static int uniphier_aio_hw_params(struct snd_pcm_substream *substream,
277 struct snd_pcm_hw_params *params,
278 struct snd_soc_dai *dai)
280 struct uniphier_aio *aio = uniphier_priv(dai);
281 struct uniphier_aio_sub *sub = &aio->sub[substream->stream];
282 struct device *dev = &aio->chip->pdev->dev;
285 switch (params_rate(params)) {
296 dev_err(dev, "Rate is not supported(%d)\n",
297 params_rate(params));
300 ret = snd_soc_dai_set_sysclk(dai, AUD_CLK_A,
301 freq, SND_SOC_CLOCK_OUT);
305 sub->params = *params;
309 aio_port_set_volume(sub, sub->vol);
315 static int uniphier_aio_hw_free(struct snd_pcm_substream *substream,
316 struct snd_soc_dai *dai)
318 struct uniphier_aio *aio = uniphier_priv(dai);
319 struct uniphier_aio_sub *sub = &aio->sub[substream->stream];
326 static int uniphier_aio_prepare(struct snd_pcm_substream *substream,
327 struct snd_soc_dai *dai)
329 struct uniphier_aio *aio = uniphier_priv(dai);
330 struct uniphier_aio_sub *sub = &aio->sub[substream->stream];
333 ret = aio_port_set_param(sub, sub->pass_through, &sub->params);
336 ret = aio_src_set_param(sub, &sub->params);
339 aio_port_set_enable(sub, 1);
341 ret = aio_if_set_param(sub, sub->pass_through);
345 if (sub->swm->type == PORT_TYPE_CONV) {
346 ret = aio_srcif_set_param(sub);
349 ret = aio_srcch_set_param(sub);
352 aio_srcch_set_enable(sub, 1);
358 static int uniphier_aio_dai_probe(struct snd_soc_dai *dai)
360 struct uniphier_aio *aio = uniphier_priv(dai);
363 for (i = 0; i < ARRAY_SIZE(aio->sub); i++) {
364 struct uniphier_aio_sub *sub = &aio->sub[i];
365 const struct uniphier_aio_spec *spec;
367 spec = find_spec(aio, dai->name, i);
371 sub->swm = &spec->swm;
374 sub->vol = AUD_VOL_INIT;
377 aio_iecout_set_enable(aio->chip, true);
378 aio_chip_init(aio->chip);
379 aio->chip->active = 1;
384 static int uniphier_aio_dai_remove(struct snd_soc_dai *dai)
386 struct uniphier_aio *aio = uniphier_priv(dai);
388 aio->chip->active = 0;
393 static int uniphier_aio_ld11_probe(struct snd_soc_dai *dai)
397 ret = uniphier_aio_dai_probe(dai);
401 ret = snd_soc_dai_set_pll(dai, AUD_PLL_A1, 0, 0, 36864000);
404 ret = snd_soc_dai_set_pll(dai, AUD_PLL_F1, 0, 0, 36864000);
408 ret = snd_soc_dai_set_pll(dai, AUD_PLL_A2, 0, 0, 33868800);
411 ret = snd_soc_dai_set_pll(dai, AUD_PLL_F2, 0, 0, 33868800);
418 static int uniphier_aio_pxs2_probe(struct snd_soc_dai *dai)
422 ret = uniphier_aio_dai_probe(dai);
426 ret = snd_soc_dai_set_pll(dai, AUD_PLL_A1, 0, 0, 36864000);
429 ret = snd_soc_dai_set_pll(dai, AUD_PLL_F1, 0, 0, 36864000);
433 ret = snd_soc_dai_set_pll(dai, AUD_PLL_A2, 0, 0, 33868800);
436 ret = snd_soc_dai_set_pll(dai, AUD_PLL_F2, 0, 0, 33868800);
443 const struct snd_soc_dai_ops uniphier_aio_i2s_ld11_ops = {
444 .probe = uniphier_aio_ld11_probe,
445 .remove = uniphier_aio_dai_remove,
446 .set_sysclk = uniphier_aio_set_sysclk,
447 .set_pll = uniphier_aio_set_pll,
448 .set_fmt = uniphier_aio_set_fmt,
449 .startup = uniphier_aio_startup,
450 .shutdown = uniphier_aio_shutdown,
451 .hw_params = uniphier_aio_hw_params,
452 .hw_free = uniphier_aio_hw_free,
453 .prepare = uniphier_aio_prepare,
455 EXPORT_SYMBOL_GPL(uniphier_aio_i2s_ld11_ops);
457 const struct snd_soc_dai_ops uniphier_aio_spdif_ld11_ops = {
458 .probe = uniphier_aio_ld11_probe,
459 .remove = uniphier_aio_dai_remove,
460 .set_sysclk = uniphier_aio_set_sysclk,
461 .set_pll = uniphier_aio_set_pll,
462 .startup = uniphier_aio_startup,
463 .shutdown = uniphier_aio_shutdown,
464 .hw_params = uniphier_aio_hw_params,
465 .hw_free = uniphier_aio_hw_free,
466 .prepare = uniphier_aio_prepare,
468 EXPORT_SYMBOL_GPL(uniphier_aio_spdif_ld11_ops);
470 const struct snd_soc_dai_ops uniphier_aio_spdif_ld11_ops2 = {
471 .probe = uniphier_aio_ld11_probe,
472 .remove = uniphier_aio_dai_remove,
473 .set_sysclk = uniphier_aio_set_sysclk,
474 .set_pll = uniphier_aio_set_pll,
475 .startup = uniphier_aio_startup,
476 .shutdown = uniphier_aio_shutdown,
477 .hw_params = uniphier_aio_hw_params,
478 .hw_free = uniphier_aio_hw_free,
479 .prepare = uniphier_aio_prepare,
480 .compress_new = snd_soc_new_compress,
482 EXPORT_SYMBOL_GPL(uniphier_aio_spdif_ld11_ops2);
484 const struct snd_soc_dai_ops uniphier_aio_i2s_pxs2_ops = {
485 .probe = uniphier_aio_pxs2_probe,
486 .remove = uniphier_aio_dai_remove,
487 .set_sysclk = uniphier_aio_set_sysclk,
488 .set_pll = uniphier_aio_set_pll,
489 .set_fmt = uniphier_aio_set_fmt,
490 .startup = uniphier_aio_startup,
491 .shutdown = uniphier_aio_shutdown,
492 .hw_params = uniphier_aio_hw_params,
493 .hw_free = uniphier_aio_hw_free,
494 .prepare = uniphier_aio_prepare,
496 EXPORT_SYMBOL_GPL(uniphier_aio_i2s_pxs2_ops);
498 const struct snd_soc_dai_ops uniphier_aio_spdif_pxs2_ops = {
499 .probe = uniphier_aio_pxs2_probe,
500 .remove = uniphier_aio_dai_remove,
501 .set_sysclk = uniphier_aio_set_sysclk,
502 .set_pll = uniphier_aio_set_pll,
503 .startup = uniphier_aio_startup,
504 .shutdown = uniphier_aio_shutdown,
505 .hw_params = uniphier_aio_hw_params,
506 .hw_free = uniphier_aio_hw_free,
507 .prepare = uniphier_aio_prepare,
509 EXPORT_SYMBOL_GPL(uniphier_aio_spdif_pxs2_ops);
511 const struct snd_soc_dai_ops uniphier_aio_spdif_pxs2_ops2 = {
512 .probe = uniphier_aio_pxs2_probe,
513 .remove = uniphier_aio_dai_remove,
514 .set_sysclk = uniphier_aio_set_sysclk,
515 .set_pll = uniphier_aio_set_pll,
516 .startup = uniphier_aio_startup,
517 .shutdown = uniphier_aio_shutdown,
518 .hw_params = uniphier_aio_hw_params,
519 .hw_free = uniphier_aio_hw_free,
520 .prepare = uniphier_aio_prepare,
521 .compress_new = snd_soc_new_compress,
523 EXPORT_SYMBOL_GPL(uniphier_aio_spdif_pxs2_ops2);
525 static void uniphier_aio_dai_suspend(struct snd_soc_dai *dai)
527 struct uniphier_aio *aio = uniphier_priv(dai);
529 if (!snd_soc_dai_active(dai))
532 aio->chip->num_wup_aios--;
533 if (!aio->chip->num_wup_aios) {
534 reset_control_assert(aio->chip->rst);
535 clk_disable_unprepare(aio->chip->clk);
539 static int uniphier_aio_suspend(struct snd_soc_component *component)
541 struct snd_soc_dai *dai;
543 for_each_component_dais(component, dai)
544 uniphier_aio_dai_suspend(dai);
548 static int uniphier_aio_dai_resume(struct snd_soc_dai *dai)
550 struct uniphier_aio *aio = uniphier_priv(dai);
553 if (!snd_soc_dai_active(dai))
556 if (!aio->chip->active)
559 if (!aio->chip->num_wup_aios) {
560 ret = clk_prepare_enable(aio->chip->clk);
564 ret = reset_control_deassert(aio->chip->rst);
569 aio_iecout_set_enable(aio->chip, true);
570 aio_chip_init(aio->chip);
572 for (i = 0; i < ARRAY_SIZE(aio->sub); i++) {
573 struct uniphier_aio_sub *sub = &aio->sub[i];
575 if (!sub->spec || !sub->substream)
588 aio->chip->num_wup_aios++;
593 if (!aio->chip->num_wup_aios)
594 reset_control_assert(aio->chip->rst);
596 if (!aio->chip->num_wup_aios)
597 clk_disable_unprepare(aio->chip->clk);
602 static int uniphier_aio_resume(struct snd_soc_component *component)
604 struct snd_soc_dai *dai;
607 for_each_component_dais(component, dai)
608 ret |= uniphier_aio_dai_resume(dai);
612 static int uniphier_aio_vol_info(struct snd_kcontrol *kcontrol,
613 struct snd_ctl_elem_info *uinfo)
615 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
617 uinfo->value.integer.min = 0;
618 uinfo->value.integer.max = AUD_VOL_MAX;
623 static int uniphier_aio_vol_get(struct snd_kcontrol *kcontrol,
624 struct snd_ctl_elem_value *ucontrol)
626 struct snd_soc_component *comp = snd_soc_kcontrol_component(kcontrol);
627 struct uniphier_aio_chip *chip = snd_soc_component_get_drvdata(comp);
628 struct uniphier_aio_sub *sub;
629 int oport_hw = kcontrol->private_value;
631 sub = find_volume(chip, oport_hw);
635 ucontrol->value.integer.value[0] = sub->vol;
640 static int uniphier_aio_vol_put(struct snd_kcontrol *kcontrol,
641 struct snd_ctl_elem_value *ucontrol)
643 struct snd_soc_component *comp = snd_soc_kcontrol_component(kcontrol);
644 struct uniphier_aio_chip *chip = snd_soc_component_get_drvdata(comp);
645 struct uniphier_aio_sub *sub;
646 int oport_hw = kcontrol->private_value;
648 sub = find_volume(chip, oport_hw);
652 if (sub->vol == ucontrol->value.integer.value[0])
654 sub->vol = ucontrol->value.integer.value[0];
656 aio_port_set_volume(sub, sub->vol);
661 static const struct snd_kcontrol_new uniphier_aio_controls[] = {
663 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
664 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
665 .name = "HPCMOUT1 Volume",
666 .info = uniphier_aio_vol_info,
667 .get = uniphier_aio_vol_get,
668 .put = uniphier_aio_vol_put,
669 .private_value = AUD_HW_HPCMOUT1,
672 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
673 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
674 .name = "PCMOUT1 Volume",
675 .info = uniphier_aio_vol_info,
676 .get = uniphier_aio_vol_get,
677 .put = uniphier_aio_vol_put,
678 .private_value = AUD_HW_PCMOUT1,
681 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
682 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
683 .name = "PCMOUT2 Volume",
684 .info = uniphier_aio_vol_info,
685 .get = uniphier_aio_vol_get,
686 .put = uniphier_aio_vol_put,
687 .private_value = AUD_HW_PCMOUT2,
690 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
691 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
692 .name = "PCMOUT3 Volume",
693 .info = uniphier_aio_vol_info,
694 .get = uniphier_aio_vol_get,
695 .put = uniphier_aio_vol_put,
696 .private_value = AUD_HW_PCMOUT3,
699 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
700 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
701 .name = "HIECOUT1 Volume",
702 .info = uniphier_aio_vol_info,
703 .get = uniphier_aio_vol_get,
704 .put = uniphier_aio_vol_put,
705 .private_value = AUD_HW_HIECOUT1,
708 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
709 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
710 .name = "IECOUT1 Volume",
711 .info = uniphier_aio_vol_info,
712 .get = uniphier_aio_vol_get,
713 .put = uniphier_aio_vol_put,
714 .private_value = AUD_HW_IECOUT1,
718 static const struct snd_soc_component_driver uniphier_aio_component = {
719 .name = "uniphier-aio",
720 .controls = uniphier_aio_controls,
721 .num_controls = ARRAY_SIZE(uniphier_aio_controls),
722 .suspend = uniphier_aio_suspend,
723 .resume = uniphier_aio_resume,
726 int uniphier_aio_probe(struct platform_device *pdev)
728 struct uniphier_aio_chip *chip;
729 struct device *dev = &pdev->dev;
732 chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
736 chip->chip_spec = of_device_get_match_data(dev);
737 if (!chip->chip_spec)
740 chip->regmap_sg = syscon_regmap_lookup_by_phandle(dev->of_node,
742 if (IS_ERR(chip->regmap_sg)) {
743 if (PTR_ERR(chip->regmap_sg) == -EPROBE_DEFER)
744 return -EPROBE_DEFER;
745 chip->regmap_sg = NULL;
748 chip->clk = devm_clk_get(dev, "aio");
749 if (IS_ERR(chip->clk))
750 return PTR_ERR(chip->clk);
752 chip->rst = devm_reset_control_get_shared(dev, "aio");
753 if (IS_ERR(chip->rst))
754 return PTR_ERR(chip->rst);
756 chip->num_aios = chip->chip_spec->num_dais;
757 chip->num_wup_aios = chip->num_aios;
758 chip->aios = devm_kcalloc(dev,
759 chip->num_aios, sizeof(struct uniphier_aio),
764 chip->num_plls = chip->chip_spec->num_plls;
765 chip->plls = devm_kcalloc(dev,
767 sizeof(struct uniphier_aio_pll),
771 memcpy(chip->plls, chip->chip_spec->plls,
772 sizeof(struct uniphier_aio_pll) * chip->num_plls);
774 for (i = 0; i < chip->num_aios; i++) {
775 struct uniphier_aio *aio = &chip->aios[i];
778 aio->fmt = SND_SOC_DAIFMT_I2S;
780 for (j = 0; j < ARRAY_SIZE(aio->sub); j++) {
781 struct uniphier_aio_sub *sub = &aio->sub[j];
784 spin_lock_init(&sub->lock);
789 platform_set_drvdata(pdev, chip);
791 ret = clk_prepare_enable(chip->clk);
795 ret = reset_control_deassert(chip->rst);
799 ret = devm_snd_soc_register_component(dev, &uniphier_aio_component,
800 chip->chip_spec->dais,
801 chip->chip_spec->num_dais);
803 dev_err(dev, "Register component failed.\n");
807 ret = uniphier_aiodma_soc_register_platform(pdev);
809 dev_err(dev, "Register platform failed.\n");
816 reset_control_assert(chip->rst);
819 clk_disable_unprepare(chip->clk);
823 EXPORT_SYMBOL_GPL(uniphier_aio_probe);
825 void uniphier_aio_remove(struct platform_device *pdev)
827 struct uniphier_aio_chip *chip = platform_get_drvdata(pdev);
829 reset_control_assert(chip->rst);
830 clk_disable_unprepare(chip->clk);
832 EXPORT_SYMBOL_GPL(uniphier_aio_remove);
834 MODULE_AUTHOR("Katsuhiro Suzuki <suzuki.katsuhiro@socionext.com>");
835 MODULE_DESCRIPTION("UniPhier AIO CPU DAI driver.");
836 MODULE_LICENSE("GPL v2");