xref: /openbmc/linux/sound/soc/fsl/fsl_asrc_dma.c (revision 89aba575)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Freescale ASRC ALSA SoC Platform (DMA) driver
4 //
5 // Copyright (C) 2014 Freescale Semiconductor, Inc.
6 //
7 // Author: Nicolin Chen <nicoleotsuka@gmail.com>
8 
9 #include <linux/dma-mapping.h>
10 #include <linux/module.h>
11 #include <linux/dma/imx-dma.h>
12 #include <sound/dmaengine_pcm.h>
13 #include <sound/pcm_params.h>
14 
15 #include "fsl_asrc_common.h"
16 
17 #define FSL_ASRC_DMABUF_SIZE	(256 * 1024)
18 
19 static struct snd_pcm_hardware snd_imx_hardware = {
20 	.info = SNDRV_PCM_INFO_INTERLEAVED |
21 		SNDRV_PCM_INFO_BLOCK_TRANSFER |
22 		SNDRV_PCM_INFO_MMAP |
23 		SNDRV_PCM_INFO_MMAP_VALID,
24 	.buffer_bytes_max = FSL_ASRC_DMABUF_SIZE,
25 	.period_bytes_min = 128,
26 	.period_bytes_max = 65535, /* Limited by SDMA engine */
27 	.periods_min = 2,
28 	.periods_max = 255,
29 	.fifo_size = 0,
30 };
31 
32 static bool filter(struct dma_chan *chan, void *param)
33 {
34 	if (!imx_dma_is_general_purpose(chan))
35 		return false;
36 
37 	chan->private = param;
38 
39 	return true;
40 }
41 
42 static void fsl_asrc_dma_complete(void *arg)
43 {
44 	struct snd_pcm_substream *substream = arg;
45 	struct snd_pcm_runtime *runtime = substream->runtime;
46 	struct fsl_asrc_pair *pair = runtime->private_data;
47 
48 	pair->pos += snd_pcm_lib_period_bytes(substream);
49 	if (pair->pos >= snd_pcm_lib_buffer_bytes(substream))
50 		pair->pos = 0;
51 
52 	snd_pcm_period_elapsed(substream);
53 }
54 
55 static int fsl_asrc_dma_prepare_and_submit(struct snd_pcm_substream *substream,
56 					   struct snd_soc_component *component)
57 {
58 	u8 dir = substream->stream == SNDRV_PCM_STREAM_PLAYBACK ? OUT : IN;
59 	struct snd_pcm_runtime *runtime = substream->runtime;
60 	struct fsl_asrc_pair *pair = runtime->private_data;
61 	struct device *dev = component->dev;
62 	unsigned long flags = DMA_CTRL_ACK;
63 
64 	/* Prepare and submit Front-End DMA channel */
65 	if (!substream->runtime->no_period_wakeup)
66 		flags |= DMA_PREP_INTERRUPT;
67 
68 	pair->pos = 0;
69 	pair->desc[!dir] = dmaengine_prep_dma_cyclic(
70 			pair->dma_chan[!dir], runtime->dma_addr,
71 			snd_pcm_lib_buffer_bytes(substream),
72 			snd_pcm_lib_period_bytes(substream),
73 			dir == OUT ? DMA_MEM_TO_DEV : DMA_DEV_TO_MEM, flags);
74 	if (!pair->desc[!dir]) {
75 		dev_err(dev, "failed to prepare slave DMA for Front-End\n");
76 		return -ENOMEM;
77 	}
78 
79 	pair->desc[!dir]->callback = fsl_asrc_dma_complete;
80 	pair->desc[!dir]->callback_param = substream;
81 
82 	dmaengine_submit(pair->desc[!dir]);
83 
84 	/* Prepare and submit Back-End DMA channel */
85 	pair->desc[dir] = dmaengine_prep_dma_cyclic(
86 			pair->dma_chan[dir], 0xffff, 64, 64, DMA_DEV_TO_DEV, 0);
87 	if (!pair->desc[dir]) {
88 		dev_err(dev, "failed to prepare slave DMA for Back-End\n");
89 		return -ENOMEM;
90 	}
91 
92 	dmaengine_submit(pair->desc[dir]);
93 
94 	return 0;
95 }
96 
97 static int fsl_asrc_dma_trigger(struct snd_soc_component *component,
98 				struct snd_pcm_substream *substream, int cmd)
99 {
100 	struct snd_pcm_runtime *runtime = substream->runtime;
101 	struct fsl_asrc_pair *pair = runtime->private_data;
102 	int ret;
103 
104 	switch (cmd) {
105 	case SNDRV_PCM_TRIGGER_START:
106 	case SNDRV_PCM_TRIGGER_RESUME:
107 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
108 		ret = fsl_asrc_dma_prepare_and_submit(substream, component);
109 		if (ret)
110 			return ret;
111 		dma_async_issue_pending(pair->dma_chan[IN]);
112 		dma_async_issue_pending(pair->dma_chan[OUT]);
113 		break;
114 	case SNDRV_PCM_TRIGGER_STOP:
115 	case SNDRV_PCM_TRIGGER_SUSPEND:
116 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
117 		dmaengine_terminate_async(pair->dma_chan[OUT]);
118 		dmaengine_terminate_async(pair->dma_chan[IN]);
119 		break;
120 	default:
121 		return -EINVAL;
122 	}
123 
124 	return 0;
125 }
126 
127 static int fsl_asrc_dma_hw_params(struct snd_soc_component *component,
128 				  struct snd_pcm_substream *substream,
129 				  struct snd_pcm_hw_params *params)
130 {
131 	enum dma_slave_buswidth buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
132 	enum sdma_peripheral_type be_peripheral_type = IMX_DMATYPE_SSI;
133 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
134 	bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
135 	struct snd_dmaengine_dai_dma_data *dma_params_fe = NULL;
136 	struct snd_dmaengine_dai_dma_data *dma_params_be = NULL;
137 	struct snd_pcm_runtime *runtime = substream->runtime;
138 	struct fsl_asrc_pair *pair = runtime->private_data;
139 	struct dma_chan *tmp_chan = NULL, *be_chan = NULL;
140 	struct snd_soc_component *component_be = NULL;
141 	struct fsl_asrc *asrc = pair->asrc;
142 	struct dma_slave_config config_fe, config_be;
143 	struct sdma_peripheral_config audio_config;
144 	enum asrc_pair_index index = pair->index;
145 	struct device *dev = component->dev;
146 	struct device_node *of_dma_node;
147 	int stream = substream->stream;
148 	struct imx_dma_data *tmp_data;
149 	struct snd_soc_dpcm *dpcm;
150 	struct device *dev_be;
151 	u8 dir = tx ? OUT : IN;
152 	dma_cap_mask_t mask;
153 	int ret, width;
154 
155 	/* Fetch the Back-End dma_data from DPCM */
156 	for_each_dpcm_be(rtd, stream, dpcm) {
157 		struct snd_soc_pcm_runtime *be = dpcm->be;
158 		struct snd_pcm_substream *substream_be;
159 		struct snd_soc_dai *dai = asoc_rtd_to_cpu(be, 0);
160 
161 		if (dpcm->fe != rtd)
162 			continue;
163 
164 		substream_be = snd_soc_dpcm_get_substream(be, stream);
165 		dma_params_be = snd_soc_dai_get_dma_data(dai, substream_be);
166 		dev_be = dai->dev;
167 		break;
168 	}
169 
170 	if (!dma_params_be) {
171 		dev_err(dev, "failed to get the substream of Back-End\n");
172 		return -EINVAL;
173 	}
174 
175 	/* Override dma_data of the Front-End and config its dmaengine */
176 	dma_params_fe = snd_soc_dai_get_dma_data(asoc_rtd_to_cpu(rtd, 0), substream);
177 	dma_params_fe->addr = asrc->paddr + asrc->get_fifo_addr(!dir, index);
178 	dma_params_fe->maxburst = dma_params_be->maxburst;
179 
180 	pair->dma_chan[!dir] = asrc->get_dma_channel(pair, !dir);
181 	if (!pair->dma_chan[!dir]) {
182 		dev_err(dev, "failed to request DMA channel\n");
183 		return -EINVAL;
184 	}
185 
186 	memset(&config_fe, 0, sizeof(config_fe));
187 	ret = snd_dmaengine_pcm_prepare_slave_config(substream, params, &config_fe);
188 	if (ret) {
189 		dev_err(dev, "failed to prepare DMA config for Front-End\n");
190 		return ret;
191 	}
192 
193 	ret = dmaengine_slave_config(pair->dma_chan[!dir], &config_fe);
194 	if (ret) {
195 		dev_err(dev, "failed to config DMA channel for Front-End\n");
196 		return ret;
197 	}
198 
199 	/* Request and config DMA channel for Back-End */
200 	dma_cap_zero(mask);
201 	dma_cap_set(DMA_SLAVE, mask);
202 	dma_cap_set(DMA_CYCLIC, mask);
203 
204 	/*
205 	 * The Back-End device might have already requested a DMA channel,
206 	 * so try to reuse it first, and then request a new one upon NULL.
207 	 */
208 	component_be = snd_soc_lookup_component_nolocked(dev_be, SND_DMAENGINE_PCM_DRV_NAME);
209 	if (component_be) {
210 		be_chan = soc_component_to_pcm(component_be)->chan[substream->stream];
211 		tmp_chan = be_chan;
212 	}
213 	if (!tmp_chan)
214 		tmp_chan = dma_request_slave_channel(dev_be, tx ? "tx" : "rx");
215 
216 	/*
217 	 * An EDMA DEV_TO_DEV channel is fixed and bound with DMA event of each
218 	 * peripheral, unlike SDMA channel that is allocated dynamically. So no
219 	 * need to configure dma_request and dma_request2, but get dma_chan of
220 	 * Back-End device directly via dma_request_slave_channel.
221 	 */
222 	if (!asrc->use_edma) {
223 		/* Get DMA request of Back-End */
224 		tmp_data = tmp_chan->private;
225 		pair->dma_data.dma_request = tmp_data->dma_request;
226 		be_peripheral_type = tmp_data->peripheral_type;
227 		if (!be_chan)
228 			dma_release_channel(tmp_chan);
229 
230 		/* Get DMA request of Front-End */
231 		tmp_chan = asrc->get_dma_channel(pair, dir);
232 		tmp_data = tmp_chan->private;
233 		pair->dma_data.dma_request2 = tmp_data->dma_request;
234 		pair->dma_data.peripheral_type = tmp_data->peripheral_type;
235 		pair->dma_data.priority = tmp_data->priority;
236 		dma_release_channel(tmp_chan);
237 
238 		of_dma_node = pair->dma_chan[!dir]->device->dev->of_node;
239 		pair->dma_chan[dir] =
240 			__dma_request_channel(&mask, filter, &pair->dma_data,
241 					      of_dma_node);
242 		pair->req_dma_chan = true;
243 	} else {
244 		pair->dma_chan[dir] = tmp_chan;
245 		/* Do not flag to release if we are reusing the Back-End one */
246 		pair->req_dma_chan = !be_chan;
247 	}
248 
249 	if (!pair->dma_chan[dir]) {
250 		dev_err(dev, "failed to request DMA channel for Back-End\n");
251 		return -EINVAL;
252 	}
253 
254 	width = snd_pcm_format_physical_width(asrc->asrc_format);
255 	if (width < 8 || width > 64)
256 		return -EINVAL;
257 	else if (width == 8)
258 		buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE;
259 	else if (width == 16)
260 		buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
261 	else if (width == 24)
262 		buswidth = DMA_SLAVE_BUSWIDTH_3_BYTES;
263 	else if (width <= 32)
264 		buswidth = DMA_SLAVE_BUSWIDTH_4_BYTES;
265 	else
266 		buswidth = DMA_SLAVE_BUSWIDTH_8_BYTES;
267 
268 	config_be.direction = DMA_DEV_TO_DEV;
269 	config_be.src_addr_width = buswidth;
270 	config_be.src_maxburst = dma_params_be->maxburst;
271 	config_be.dst_addr_width = buswidth;
272 	config_be.dst_maxburst = dma_params_be->maxburst;
273 
274 	memset(&audio_config, 0, sizeof(audio_config));
275 	config_be.peripheral_config = &audio_config;
276 	config_be.peripheral_size  = sizeof(audio_config);
277 
278 	if (tx && (be_peripheral_type == IMX_DMATYPE_SSI_DUAL ||
279 		   be_peripheral_type == IMX_DMATYPE_SPDIF))
280 		audio_config.n_fifos_dst = 2;
281 	if (!tx && (be_peripheral_type == IMX_DMATYPE_SSI_DUAL ||
282 		    be_peripheral_type == IMX_DMATYPE_SPDIF))
283 		audio_config.n_fifos_src = 2;
284 
285 	if (tx) {
286 		config_be.src_addr = asrc->paddr + asrc->get_fifo_addr(OUT, index);
287 		config_be.dst_addr = dma_params_be->addr;
288 	} else {
289 		config_be.dst_addr = asrc->paddr + asrc->get_fifo_addr(IN, index);
290 		config_be.src_addr = dma_params_be->addr;
291 	}
292 
293 	ret = dmaengine_slave_config(pair->dma_chan[dir], &config_be);
294 	if (ret) {
295 		dev_err(dev, "failed to config DMA channel for Back-End\n");
296 		if (pair->req_dma_chan)
297 			dma_release_channel(pair->dma_chan[dir]);
298 		return ret;
299 	}
300 
301 	return 0;
302 }
303 
304 static int fsl_asrc_dma_hw_free(struct snd_soc_component *component,
305 				struct snd_pcm_substream *substream)
306 {
307 	bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
308 	struct snd_pcm_runtime *runtime = substream->runtime;
309 	struct fsl_asrc_pair *pair = runtime->private_data;
310 	u8 dir = tx ? OUT : IN;
311 
312 	if (pair->dma_chan[!dir])
313 		dma_release_channel(pair->dma_chan[!dir]);
314 
315 	/* release dev_to_dev chan if we aren't reusing the Back-End one */
316 	if (pair->dma_chan[dir] && pair->req_dma_chan)
317 		dma_release_channel(pair->dma_chan[dir]);
318 
319 	pair->dma_chan[!dir] = NULL;
320 	pair->dma_chan[dir] = NULL;
321 
322 	return 0;
323 }
324 
325 static int fsl_asrc_dma_startup(struct snd_soc_component *component,
326 				struct snd_pcm_substream *substream)
327 {
328 	bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
329 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
330 	struct snd_pcm_runtime *runtime = substream->runtime;
331 	struct snd_dmaengine_dai_dma_data *dma_data;
332 	struct device *dev = component->dev;
333 	struct fsl_asrc *asrc = dev_get_drvdata(dev);
334 	struct fsl_asrc_pair *pair;
335 	struct dma_chan *tmp_chan = NULL;
336 	u8 dir = tx ? OUT : IN;
337 	bool release_pair = true;
338 	int ret = 0;
339 
340 	ret = snd_pcm_hw_constraint_integer(substream->runtime,
341 					    SNDRV_PCM_HW_PARAM_PERIODS);
342 	if (ret < 0) {
343 		dev_err(dev, "failed to set pcm hw params periods\n");
344 		return ret;
345 	}
346 
347 	pair = kzalloc(sizeof(*pair) + asrc->pair_priv_size, GFP_KERNEL);
348 	if (!pair)
349 		return -ENOMEM;
350 
351 	pair->asrc = asrc;
352 	pair->private = (void *)pair + sizeof(struct fsl_asrc_pair);
353 
354 	runtime->private_data = pair;
355 
356 	/* Request a dummy pair, which will be released later.
357 	 * Request pair function needs channel num as input, for this
358 	 * dummy pair, we just request "1" channel temporarily.
359 	 */
360 	ret = asrc->request_pair(1, pair);
361 	if (ret < 0) {
362 		dev_err(dev, "failed to request asrc pair\n");
363 		goto req_pair_err;
364 	}
365 
366 	/* Request a dummy dma channel, which will be released later. */
367 	tmp_chan = asrc->get_dma_channel(pair, dir);
368 	if (!tmp_chan) {
369 		dev_err(dev, "failed to get dma channel\n");
370 		ret = -EINVAL;
371 		goto dma_chan_err;
372 	}
373 
374 	dma_data = snd_soc_dai_get_dma_data(asoc_rtd_to_cpu(rtd, 0), substream);
375 
376 	/* Refine the snd_imx_hardware according to caps of DMA. */
377 	ret = snd_dmaengine_pcm_refine_runtime_hwparams(substream,
378 							dma_data,
379 							&snd_imx_hardware,
380 							tmp_chan);
381 	if (ret < 0) {
382 		dev_err(dev, "failed to refine runtime hwparams\n");
383 		goto out;
384 	}
385 
386 	release_pair = false;
387 	snd_soc_set_runtime_hwparams(substream, &snd_imx_hardware);
388 
389 out:
390 	dma_release_channel(tmp_chan);
391 
392 dma_chan_err:
393 	asrc->release_pair(pair);
394 
395 req_pair_err:
396 	if (release_pair)
397 		kfree(pair);
398 
399 	return ret;
400 }
401 
402 static int fsl_asrc_dma_shutdown(struct snd_soc_component *component,
403 				 struct snd_pcm_substream *substream)
404 {
405 	struct snd_pcm_runtime *runtime = substream->runtime;
406 	struct fsl_asrc_pair *pair = runtime->private_data;
407 	struct fsl_asrc *asrc;
408 
409 	if (!pair)
410 		return 0;
411 
412 	asrc = pair->asrc;
413 
414 	if (asrc->pair[pair->index] == pair)
415 		asrc->pair[pair->index] = NULL;
416 
417 	kfree(pair);
418 
419 	return 0;
420 }
421 
422 static snd_pcm_uframes_t
423 fsl_asrc_dma_pcm_pointer(struct snd_soc_component *component,
424 			 struct snd_pcm_substream *substream)
425 {
426 	struct snd_pcm_runtime *runtime = substream->runtime;
427 	struct fsl_asrc_pair *pair = runtime->private_data;
428 
429 	return bytes_to_frames(substream->runtime, pair->pos);
430 }
431 
432 static int fsl_asrc_dma_pcm_new(struct snd_soc_component *component,
433 				struct snd_soc_pcm_runtime *rtd)
434 {
435 	struct snd_card *card = rtd->card->snd_card;
436 	struct snd_pcm *pcm = rtd->pcm;
437 	int ret;
438 
439 	ret = dma_coerce_mask_and_coherent(card->dev, DMA_BIT_MASK(32));
440 	if (ret) {
441 		dev_err(card->dev, "failed to set DMA mask\n");
442 		return ret;
443 	}
444 
445 	return snd_pcm_set_fixed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV,
446 					    card->dev, FSL_ASRC_DMABUF_SIZE);
447 }
448 
449 struct snd_soc_component_driver fsl_asrc_component = {
450 	.name		= DRV_NAME,
451 	.hw_params	= fsl_asrc_dma_hw_params,
452 	.hw_free	= fsl_asrc_dma_hw_free,
453 	.trigger	= fsl_asrc_dma_trigger,
454 	.open		= fsl_asrc_dma_startup,
455 	.close		= fsl_asrc_dma_shutdown,
456 	.pointer	= fsl_asrc_dma_pcm_pointer,
457 	.pcm_construct	= fsl_asrc_dma_pcm_new,
458 	.legacy_dai_naming = 1,
459 };
460 EXPORT_SYMBOL_GPL(fsl_asrc_component);
461