xref: /openbmc/linux/sound/soc/fsl/fsl_rpmsg.c (revision 2fbbcffea5b6adbfe90ffc842a6b3eb2d7e381ed)
1b73d9e62SShengjiu Wang // SPDX-License-Identifier: GPL-2.0+
2b73d9e62SShengjiu Wang // Copyright 2018-2021 NXP
3b73d9e62SShengjiu Wang 
4b73d9e62SShengjiu Wang #include <linux/clk.h>
5b73d9e62SShengjiu Wang #include <linux/clk-provider.h>
6b73d9e62SShengjiu Wang #include <linux/delay.h>
7b73d9e62SShengjiu Wang #include <linux/dmaengine.h>
8b73d9e62SShengjiu Wang #include <linux/module.h>
9b73d9e62SShengjiu Wang #include <linux/of_device.h>
10b73d9e62SShengjiu Wang #include <linux/of_address.h>
11b73d9e62SShengjiu Wang #include <linux/pm_runtime.h>
12b73d9e62SShengjiu Wang #include <linux/rpmsg.h>
13b73d9e62SShengjiu Wang #include <linux/slab.h>
14b73d9e62SShengjiu Wang #include <sound/core.h>
15b73d9e62SShengjiu Wang #include <sound/dmaengine_pcm.h>
16b73d9e62SShengjiu Wang #include <sound/pcm_params.h>
17b73d9e62SShengjiu Wang 
18b73d9e62SShengjiu Wang #include "fsl_rpmsg.h"
19b73d9e62SShengjiu Wang #include "imx-pcm.h"
20b73d9e62SShengjiu Wang 
21b73d9e62SShengjiu Wang #define FSL_RPMSG_RATES        (SNDRV_PCM_RATE_8000 | \
22b73d9e62SShengjiu Wang 				SNDRV_PCM_RATE_16000 | \
23b73d9e62SShengjiu Wang 				SNDRV_PCM_RATE_48000)
24b73d9e62SShengjiu Wang #define FSL_RPMSG_FORMATS	SNDRV_PCM_FMTBIT_S16_LE
25b73d9e62SShengjiu Wang 
26b73d9e62SShengjiu Wang /* 192kHz/32bit/2ch/60s size is 0x574e00 */
27b73d9e62SShengjiu Wang #define LPA_LARGE_BUFFER_SIZE  (0x6000000)
28b73d9e62SShengjiu Wang 
29b73d9e62SShengjiu Wang static const unsigned int fsl_rpmsg_rates[] = {
30b73d9e62SShengjiu Wang 	8000, 11025, 16000, 22050, 44100,
31b73d9e62SShengjiu Wang 	32000, 48000, 96000, 88200, 176400, 192000,
32b73d9e62SShengjiu Wang 	352800, 384000, 705600, 768000, 1411200, 2822400,
33b73d9e62SShengjiu Wang };
34b73d9e62SShengjiu Wang 
35b73d9e62SShengjiu Wang static const struct snd_pcm_hw_constraint_list fsl_rpmsg_rate_constraints = {
36b73d9e62SShengjiu Wang 	.count = ARRAY_SIZE(fsl_rpmsg_rates),
37b73d9e62SShengjiu Wang 	.list = fsl_rpmsg_rates,
38b73d9e62SShengjiu Wang };
39b73d9e62SShengjiu Wang 
40b73d9e62SShengjiu Wang static int fsl_rpmsg_hw_params(struct snd_pcm_substream *substream,
41b73d9e62SShengjiu Wang 			       struct snd_pcm_hw_params *params,
42b73d9e62SShengjiu Wang 			       struct snd_soc_dai *dai)
43b73d9e62SShengjiu Wang {
44b73d9e62SShengjiu Wang 	struct fsl_rpmsg *rpmsg = snd_soc_dai_get_drvdata(dai);
45502e5321SShengjiu Wang 	struct clk *p = rpmsg->mclk, *pll = NULL, *npll = NULL;
46b73d9e62SShengjiu Wang 	u64 rate = params_rate(params);
47b73d9e62SShengjiu Wang 	int ret = 0;
48b73d9e62SShengjiu Wang 
49b73d9e62SShengjiu Wang 	/* Get current pll parent */
50b73d9e62SShengjiu Wang 	while (p && rpmsg->pll8k && rpmsg->pll11k) {
51b73d9e62SShengjiu Wang 		struct clk *pp = clk_get_parent(p);
52b73d9e62SShengjiu Wang 
53b73d9e62SShengjiu Wang 		if (clk_is_match(pp, rpmsg->pll8k) ||
54b73d9e62SShengjiu Wang 		    clk_is_match(pp, rpmsg->pll11k)) {
55b73d9e62SShengjiu Wang 			pll = pp;
56b73d9e62SShengjiu Wang 			break;
57b73d9e62SShengjiu Wang 		}
58b73d9e62SShengjiu Wang 		p = pp;
59b73d9e62SShengjiu Wang 	}
60b73d9e62SShengjiu Wang 
61b73d9e62SShengjiu Wang 	/* Switch to another pll parent if needed. */
62b73d9e62SShengjiu Wang 	if (pll) {
63b73d9e62SShengjiu Wang 		npll = (do_div(rate, 8000) ? rpmsg->pll11k : rpmsg->pll8k);
64b73d9e62SShengjiu Wang 		if (!clk_is_match(pll, npll)) {
65b73d9e62SShengjiu Wang 			ret = clk_set_parent(p, npll);
66b73d9e62SShengjiu Wang 			if (ret < 0)
67b73d9e62SShengjiu Wang 				dev_warn(dai->dev, "failed to set parent %s: %d\n",
68b73d9e62SShengjiu Wang 					 __clk_get_name(npll), ret);
69b73d9e62SShengjiu Wang 		}
70b73d9e62SShengjiu Wang 	}
71b73d9e62SShengjiu Wang 
72b73d9e62SShengjiu Wang 	if (!(rpmsg->mclk_streams & BIT(substream->stream))) {
73b73d9e62SShengjiu Wang 		ret = clk_prepare_enable(rpmsg->mclk);
74b73d9e62SShengjiu Wang 		if (ret) {
75b73d9e62SShengjiu Wang 			dev_err(dai->dev, "failed to enable mclk: %d\n", ret);
76b73d9e62SShengjiu Wang 			return ret;
77b73d9e62SShengjiu Wang 		}
78b73d9e62SShengjiu Wang 
79b73d9e62SShengjiu Wang 		rpmsg->mclk_streams |= BIT(substream->stream);
80b73d9e62SShengjiu Wang 	}
81b73d9e62SShengjiu Wang 
82b73d9e62SShengjiu Wang 	return ret;
83b73d9e62SShengjiu Wang }
84b73d9e62SShengjiu Wang 
85b73d9e62SShengjiu Wang static int fsl_rpmsg_hw_free(struct snd_pcm_substream *substream,
86b73d9e62SShengjiu Wang 			     struct snd_soc_dai *dai)
87b73d9e62SShengjiu Wang {
88b73d9e62SShengjiu Wang 	struct fsl_rpmsg *rpmsg = snd_soc_dai_get_drvdata(dai);
89b73d9e62SShengjiu Wang 
90b73d9e62SShengjiu Wang 	if (rpmsg->mclk_streams & BIT(substream->stream)) {
91b73d9e62SShengjiu Wang 		clk_disable_unprepare(rpmsg->mclk);
92b73d9e62SShengjiu Wang 		rpmsg->mclk_streams &= ~BIT(substream->stream);
93b73d9e62SShengjiu Wang 	}
94b73d9e62SShengjiu Wang 
95b73d9e62SShengjiu Wang 	return 0;
96b73d9e62SShengjiu Wang }
97b73d9e62SShengjiu Wang 
98b73d9e62SShengjiu Wang static int fsl_rpmsg_startup(struct snd_pcm_substream *substream,
99b73d9e62SShengjiu Wang 			     struct snd_soc_dai *cpu_dai)
100b73d9e62SShengjiu Wang {
101b73d9e62SShengjiu Wang 	int ret;
102b73d9e62SShengjiu Wang 
103b73d9e62SShengjiu Wang 	ret = snd_pcm_hw_constraint_list(substream->runtime, 0,
104b73d9e62SShengjiu Wang 					 SNDRV_PCM_HW_PARAM_RATE,
105b73d9e62SShengjiu Wang 					 &fsl_rpmsg_rate_constraints);
106b73d9e62SShengjiu Wang 
107b73d9e62SShengjiu Wang 	return ret;
108b73d9e62SShengjiu Wang }
109b73d9e62SShengjiu Wang 
110b73d9e62SShengjiu Wang static const struct snd_soc_dai_ops fsl_rpmsg_dai_ops = {
111b73d9e62SShengjiu Wang 	.startup	= fsl_rpmsg_startup,
112b73d9e62SShengjiu Wang 	.hw_params      = fsl_rpmsg_hw_params,
113b73d9e62SShengjiu Wang 	.hw_free        = fsl_rpmsg_hw_free,
114b73d9e62SShengjiu Wang };
115b73d9e62SShengjiu Wang 
116b73d9e62SShengjiu Wang static struct snd_soc_dai_driver fsl_rpmsg_dai = {
117b73d9e62SShengjiu Wang 	.playback = {
118b73d9e62SShengjiu Wang 		.stream_name = "CPU-Playback",
119b73d9e62SShengjiu Wang 		.channels_min = 2,
120b73d9e62SShengjiu Wang 		.channels_max = 2,
121b73d9e62SShengjiu Wang 		.rates = SNDRV_PCM_RATE_KNOT,
122b73d9e62SShengjiu Wang 		.formats = FSL_RPMSG_FORMATS,
123b73d9e62SShengjiu Wang 	},
124b73d9e62SShengjiu Wang 	.capture = {
125b73d9e62SShengjiu Wang 		.stream_name = "CPU-Capture",
126b73d9e62SShengjiu Wang 		.channels_min = 2,
127b73d9e62SShengjiu Wang 		.channels_max = 2,
128b73d9e62SShengjiu Wang 		.rates = SNDRV_PCM_RATE_KNOT,
129b73d9e62SShengjiu Wang 		.formats = FSL_RPMSG_FORMATS,
130b73d9e62SShengjiu Wang 	},
131b73d9e62SShengjiu Wang 	.symmetric_rate        = 1,
132b73d9e62SShengjiu Wang 	.symmetric_channels    = 1,
133b73d9e62SShengjiu Wang 	.symmetric_sample_bits = 1,
134b73d9e62SShengjiu Wang 	.ops = &fsl_rpmsg_dai_ops,
135b73d9e62SShengjiu Wang };
136b73d9e62SShengjiu Wang 
137b73d9e62SShengjiu Wang static const struct snd_soc_component_driver fsl_component = {
138b73d9e62SShengjiu Wang 	.name           = "fsl-rpmsg",
139b73d9e62SShengjiu Wang };
140b73d9e62SShengjiu Wang 
141b73d9e62SShengjiu Wang static const struct of_device_id fsl_rpmsg_ids[] = {
142b73d9e62SShengjiu Wang 	{ .compatible = "fsl,imx7ulp-rpmsg-audio"},
143b73d9e62SShengjiu Wang 	{ .compatible = "fsl,imx8mm-rpmsg-audio"},
144b73d9e62SShengjiu Wang 	{ .compatible = "fsl,imx8mn-rpmsg-audio"},
145b73d9e62SShengjiu Wang 	{ .compatible = "fsl,imx8mp-rpmsg-audio"},
146b73d9e62SShengjiu Wang 	{ /* sentinel */ }
147b73d9e62SShengjiu Wang };
148b73d9e62SShengjiu Wang MODULE_DEVICE_TABLE(of, fsl_rpmsg_ids);
149b73d9e62SShengjiu Wang 
150b73d9e62SShengjiu Wang static int fsl_rpmsg_probe(struct platform_device *pdev)
151b73d9e62SShengjiu Wang {
152b73d9e62SShengjiu Wang 	struct device_node *np = pdev->dev.of_node;
153b73d9e62SShengjiu Wang 	struct fsl_rpmsg *rpmsg;
154b73d9e62SShengjiu Wang 	int ret;
155b73d9e62SShengjiu Wang 
156b73d9e62SShengjiu Wang 	rpmsg = devm_kzalloc(&pdev->dev, sizeof(struct fsl_rpmsg), GFP_KERNEL);
157b73d9e62SShengjiu Wang 	if (!rpmsg)
158b73d9e62SShengjiu Wang 		return -ENOMEM;
159b73d9e62SShengjiu Wang 
160b73d9e62SShengjiu Wang 	if (of_property_read_bool(np, "fsl,enable-lpa")) {
161b73d9e62SShengjiu Wang 		rpmsg->enable_lpa = 1;
162b73d9e62SShengjiu Wang 		rpmsg->buffer_size = LPA_LARGE_BUFFER_SIZE;
163b73d9e62SShengjiu Wang 	} else {
164b73d9e62SShengjiu Wang 		rpmsg->buffer_size = IMX_DEFAULT_DMABUF_SIZE;
165b73d9e62SShengjiu Wang 	}
166b73d9e62SShengjiu Wang 
167b73d9e62SShengjiu Wang 	/* Get the optional clocks */
168*2fbbcffeSShengjiu Wang 	rpmsg->ipg = devm_clk_get_optional(&pdev->dev, "ipg");
169b73d9e62SShengjiu Wang 	if (IS_ERR(rpmsg->ipg))
170*2fbbcffeSShengjiu Wang 		return PTR_ERR(rpmsg->ipg);
171b73d9e62SShengjiu Wang 
172*2fbbcffeSShengjiu Wang 	rpmsg->mclk = devm_clk_get_optional(&pdev->dev, "mclk");
173b73d9e62SShengjiu Wang 	if (IS_ERR(rpmsg->mclk))
174*2fbbcffeSShengjiu Wang 		return PTR_ERR(rpmsg->mclk);
175b73d9e62SShengjiu Wang 
176*2fbbcffeSShengjiu Wang 	rpmsg->dma = devm_clk_get_optional(&pdev->dev, "dma");
177b73d9e62SShengjiu Wang 	if (IS_ERR(rpmsg->dma))
178*2fbbcffeSShengjiu Wang 		return PTR_ERR(rpmsg->dma);
179b73d9e62SShengjiu Wang 
180*2fbbcffeSShengjiu Wang 	rpmsg->pll8k = devm_clk_get_optional(&pdev->dev, "pll8k");
181b73d9e62SShengjiu Wang 	if (IS_ERR(rpmsg->pll8k))
182*2fbbcffeSShengjiu Wang 		return PTR_ERR(rpmsg->pll8k);
183b73d9e62SShengjiu Wang 
184*2fbbcffeSShengjiu Wang 	rpmsg->pll11k = devm_clk_get_optional(&pdev->dev, "pll11k");
185b73d9e62SShengjiu Wang 	if (IS_ERR(rpmsg->pll11k))
186*2fbbcffeSShengjiu Wang 		return PTR_ERR(rpmsg->pll11k);
187b73d9e62SShengjiu Wang 
188b73d9e62SShengjiu Wang 	platform_set_drvdata(pdev, rpmsg);
189b73d9e62SShengjiu Wang 	pm_runtime_enable(&pdev->dev);
190b73d9e62SShengjiu Wang 
191b73d9e62SShengjiu Wang 	ret = devm_snd_soc_register_component(&pdev->dev, &fsl_component,
192b73d9e62SShengjiu Wang 					      &fsl_rpmsg_dai, 1);
193b73d9e62SShengjiu Wang 	if (ret)
194b73d9e62SShengjiu Wang 		return ret;
195b73d9e62SShengjiu Wang 
196b73d9e62SShengjiu Wang 	rpmsg->card_pdev = platform_device_register_data(&pdev->dev,
197b73d9e62SShengjiu Wang 							 "imx-audio-rpmsg",
198b73d9e62SShengjiu Wang 							 PLATFORM_DEVID_NONE,
199b73d9e62SShengjiu Wang 							 NULL,
200b73d9e62SShengjiu Wang 							 0);
201b73d9e62SShengjiu Wang 	if (IS_ERR(rpmsg->card_pdev)) {
202b73d9e62SShengjiu Wang 		dev_err(&pdev->dev, "failed to register rpmsg card\n");
203b73d9e62SShengjiu Wang 		ret = PTR_ERR(rpmsg->card_pdev);
204b73d9e62SShengjiu Wang 		return ret;
205b73d9e62SShengjiu Wang 	}
206b73d9e62SShengjiu Wang 
207b73d9e62SShengjiu Wang 	return 0;
208b73d9e62SShengjiu Wang }
209b73d9e62SShengjiu Wang 
210b73d9e62SShengjiu Wang static int fsl_rpmsg_remove(struct platform_device *pdev)
211b73d9e62SShengjiu Wang {
212b73d9e62SShengjiu Wang 	struct fsl_rpmsg *rpmsg = platform_get_drvdata(pdev);
213b73d9e62SShengjiu Wang 
214b73d9e62SShengjiu Wang 	if (rpmsg->card_pdev)
215b73d9e62SShengjiu Wang 		platform_device_unregister(rpmsg->card_pdev);
216b73d9e62SShengjiu Wang 
217b73d9e62SShengjiu Wang 	return 0;
218b73d9e62SShengjiu Wang }
219b73d9e62SShengjiu Wang 
220b73d9e62SShengjiu Wang #ifdef CONFIG_PM
221b73d9e62SShengjiu Wang static int fsl_rpmsg_runtime_resume(struct device *dev)
222b73d9e62SShengjiu Wang {
223b73d9e62SShengjiu Wang 	struct fsl_rpmsg *rpmsg = dev_get_drvdata(dev);
224b73d9e62SShengjiu Wang 	int ret;
225b73d9e62SShengjiu Wang 
226b73d9e62SShengjiu Wang 	ret = clk_prepare_enable(rpmsg->ipg);
227b73d9e62SShengjiu Wang 	if (ret) {
228b73d9e62SShengjiu Wang 		dev_err(dev, "failed to enable ipg clock: %d\n", ret);
229b73d9e62SShengjiu Wang 		goto ipg_err;
230b73d9e62SShengjiu Wang 	}
231b73d9e62SShengjiu Wang 
232b73d9e62SShengjiu Wang 	ret = clk_prepare_enable(rpmsg->dma);
233b73d9e62SShengjiu Wang 	if (ret) {
234b73d9e62SShengjiu Wang 		dev_err(dev, "Failed to enable dma clock %d\n", ret);
235b73d9e62SShengjiu Wang 		goto dma_err;
236b73d9e62SShengjiu Wang 	}
237b73d9e62SShengjiu Wang 
238b73d9e62SShengjiu Wang 	return 0;
239b73d9e62SShengjiu Wang 
240b73d9e62SShengjiu Wang dma_err:
241b73d9e62SShengjiu Wang 	clk_disable_unprepare(rpmsg->ipg);
242b73d9e62SShengjiu Wang ipg_err:
243b73d9e62SShengjiu Wang 	return ret;
244b73d9e62SShengjiu Wang }
245b73d9e62SShengjiu Wang 
246b73d9e62SShengjiu Wang static int fsl_rpmsg_runtime_suspend(struct device *dev)
247b73d9e62SShengjiu Wang {
248b73d9e62SShengjiu Wang 	struct fsl_rpmsg *rpmsg = dev_get_drvdata(dev);
249b73d9e62SShengjiu Wang 
250b73d9e62SShengjiu Wang 	clk_disable_unprepare(rpmsg->dma);
251b73d9e62SShengjiu Wang 	clk_disable_unprepare(rpmsg->ipg);
252b73d9e62SShengjiu Wang 
253b73d9e62SShengjiu Wang 	return 0;
254b73d9e62SShengjiu Wang }
255b73d9e62SShengjiu Wang #endif
256b73d9e62SShengjiu Wang 
257b73d9e62SShengjiu Wang static const struct dev_pm_ops fsl_rpmsg_pm_ops = {
258b73d9e62SShengjiu Wang 	SET_RUNTIME_PM_OPS(fsl_rpmsg_runtime_suspend,
259b73d9e62SShengjiu Wang 			   fsl_rpmsg_runtime_resume,
260b73d9e62SShengjiu Wang 			   NULL)
261b73d9e62SShengjiu Wang 	SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
262b73d9e62SShengjiu Wang 				pm_runtime_force_resume)
263b73d9e62SShengjiu Wang };
264b73d9e62SShengjiu Wang 
265b73d9e62SShengjiu Wang static struct platform_driver fsl_rpmsg_driver = {
266b73d9e62SShengjiu Wang 	.probe  = fsl_rpmsg_probe,
267b73d9e62SShengjiu Wang 	.remove = fsl_rpmsg_remove,
268b73d9e62SShengjiu Wang 	.driver = {
269b73d9e62SShengjiu Wang 		.name = "fsl_rpmsg",
270b73d9e62SShengjiu Wang 		.pm = &fsl_rpmsg_pm_ops,
271b73d9e62SShengjiu Wang 		.of_match_table = fsl_rpmsg_ids,
272b73d9e62SShengjiu Wang 	},
273b73d9e62SShengjiu Wang };
274b73d9e62SShengjiu Wang module_platform_driver(fsl_rpmsg_driver);
275b73d9e62SShengjiu Wang 
276b73d9e62SShengjiu Wang MODULE_DESCRIPTION("Freescale SoC Audio PRMSG CPU Interface");
277b73d9e62SShengjiu Wang MODULE_AUTHOR("Shengjiu Wang <shengjiu.wang@nxp.com>");
278b73d9e62SShengjiu Wang MODULE_ALIAS("platform:fsl_rpmsg");
279b73d9e62SShengjiu Wang MODULE_LICENSE("GPL");
280