blob: 697c166acf05e60cce4a23add6a0b45978259dbe [file] [log] [blame]
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +01001/*
2 * Copyright (C) 2012, Analog Devices Inc.
3 * Author: Lars-Peter Clausen <lars@metafoo.de>
4 *
5 * Based on:
6 * imx-pcm-dma-mx2.c, Copyright 2009 Sascha Hauer <s.hauer@pengutronix.de>
7 * mxs-pcm.c, Copyright (C) 2011 Freescale Semiconductor, Inc.
8 * ep93xx-pcm.c, Copyright (C) 2006 Lennert Buytenhek <buytenh@wantstofly.org>
9 * Copyright (C) 2006 Applied Data Systems
10 *
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 */
21#include <linux/module.h>
22#include <linux/init.h>
23#include <linux/dmaengine.h>
24#include <linux/slab.h>
25#include <sound/pcm.h>
26#include <sound/pcm_params.h>
27#include <sound/soc.h>
28
29#include <sound/dmaengine_pcm.h>
30
31struct dmaengine_pcm_runtime_data {
32 struct dma_chan *dma_chan;
Lars-Peter Clausen3528f272012-06-11 20:11:42 +020033 dma_cookie_t cookie;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +010034
35 unsigned int pos;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +010036};
37
38static inline struct dmaengine_pcm_runtime_data *substream_to_prtd(
39 const struct snd_pcm_substream *substream)
40{
41 return substream->runtime->private_data;
42}
43
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +010044struct dma_chan *snd_dmaengine_pcm_get_chan(struct snd_pcm_substream *substream)
45{
46 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
47
48 return prtd->dma_chan;
49}
50EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_get_chan);
51
52/**
53 * snd_hwparams_to_dma_slave_config - Convert hw_params to dma_slave_config
54 * @substream: PCM substream
55 * @params: hw_params
56 * @slave_config: DMA slave config
57 *
58 * This function can be used to initialize a dma_slave_config from a substream
59 * and hw_params in a dmaengine based PCM driver implementation.
60 */
61int snd_hwparams_to_dma_slave_config(const struct snd_pcm_substream *substream,
62 const struct snd_pcm_hw_params *params,
63 struct dma_slave_config *slave_config)
64{
65 enum dma_slave_buswidth buswidth;
Takashi Iwaia655f752013-10-25 16:33:12 +020066 int bits;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +010067
Peter Ujfalusi732814c2014-07-03 07:51:53 +030068 bits = params_physical_width(params);
Takashi Iwaia655f752013-10-25 16:33:12 +020069 if (bits < 8 || bits > 64)
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +010070 return -EINVAL;
Takashi Iwaia655f752013-10-25 16:33:12 +020071 else if (bits == 8)
72 buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE;
73 else if (bits == 16)
74 buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
Peter Ujfalusi75f850f2014-07-03 07:51:55 +030075 else if (bits == 24)
76 buswidth = DMA_SLAVE_BUSWIDTH_3_BYTES;
Takashi Iwaia655f752013-10-25 16:33:12 +020077 else if (bits <= 32)
78 buswidth = DMA_SLAVE_BUSWIDTH_4_BYTES;
79 else
80 buswidth = DMA_SLAVE_BUSWIDTH_8_BYTES;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +010081
82 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
83 slave_config->direction = DMA_MEM_TO_DEV;
84 slave_config->dst_addr_width = buswidth;
85 } else {
86 slave_config->direction = DMA_DEV_TO_MEM;
87 slave_config->src_addr_width = buswidth;
88 }
89
Lars-Peter Clausen5fa70f72013-04-03 11:02:56 +020090 slave_config->device_fc = false;
91
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +010092 return 0;
93}
94EXPORT_SYMBOL_GPL(snd_hwparams_to_dma_slave_config);
95
Lars-Peter Clausen85c9f9c2013-04-03 11:06:02 +020096/**
97 * snd_dmaengine_pcm_set_config_from_dai_data() - Initializes a dma slave config
98 * using DAI DMA data.
99 * @substream: PCM substream
100 * @dma_data: DAI DMA data
101 * @slave_config: DMA slave configuration
102 *
103 * Initializes the {dst,src}_addr, {dst,src}_maxburst, {dst,src}_addr_width and
104 * slave_id fields of the DMA slave config from the same fields of the DAI DMA
105 * data struct. The src and dst fields will be initialized depending on the
106 * direction of the substream. If the substream is a playback stream the dst
107 * fields will be initialized, if it is a capture stream the src fields will be
108 * initialized. The {dst,src}_addr_width field will only be initialized if the
109 * addr_width field of the DAI DMA data struct is not equal to
110 * DMA_SLAVE_BUSWIDTH_UNDEFINED.
111 */
112void snd_dmaengine_pcm_set_config_from_dai_data(
113 const struct snd_pcm_substream *substream,
114 const struct snd_dmaengine_dai_dma_data *dma_data,
115 struct dma_slave_config *slave_config)
116{
117 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
118 slave_config->dst_addr = dma_data->addr;
119 slave_config->dst_maxburst = dma_data->maxburst;
120 if (dma_data->addr_width != DMA_SLAVE_BUSWIDTH_UNDEFINED)
121 slave_config->dst_addr_width = dma_data->addr_width;
122 } else {
123 slave_config->src_addr = dma_data->addr;
124 slave_config->src_maxburst = dma_data->maxburst;
125 if (dma_data->addr_width != DMA_SLAVE_BUSWIDTH_UNDEFINED)
126 slave_config->src_addr_width = dma_data->addr_width;
127 }
128
129 slave_config->slave_id = dma_data->slave_id;
130}
131EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_set_config_from_dai_data);
132
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100133static void dmaengine_pcm_dma_complete(void *arg)
134{
135 struct snd_pcm_substream *substream = arg;
136 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
137
138 prtd->pos += snd_pcm_lib_period_bytes(substream);
139 if (prtd->pos >= snd_pcm_lib_buffer_bytes(substream))
140 prtd->pos = 0;
141
142 snd_pcm_period_elapsed(substream);
143}
144
145static int dmaengine_pcm_prepare_and_submit(struct snd_pcm_substream *substream)
146{
147 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
148 struct dma_chan *chan = prtd->dma_chan;
149 struct dma_async_tx_descriptor *desc;
150 enum dma_transfer_direction direction;
Peter Ujfalusie7736cd2012-09-24 10:58:04 +0300151 unsigned long flags = DMA_CTRL_ACK;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100152
153 direction = snd_pcm_substream_to_dma_direction(substream);
154
Peter Ujfalusie7736cd2012-09-24 10:58:04 +0300155 if (!substream->runtime->no_period_wakeup)
156 flags |= DMA_PREP_INTERRUPT;
157
Mika Westerberg7a08cf702012-03-05 14:02:14 +0100158 prtd->pos = 0;
Vinod Koul41ba6b72012-03-26 17:28:08 +0530159 desc = dmaengine_prep_dma_cyclic(chan,
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100160 substream->runtime->dma_addr,
161 snd_pcm_lib_buffer_bytes(substream),
Peter Ujfalusie7736cd2012-09-24 10:58:04 +0300162 snd_pcm_lib_period_bytes(substream), direction, flags);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100163
164 if (!desc)
165 return -ENOMEM;
166
167 desc->callback = dmaengine_pcm_dma_complete;
168 desc->callback_param = substream;
Lars-Peter Clausen3528f272012-06-11 20:11:42 +0200169 prtd->cookie = dmaengine_submit(desc);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100170
171 return 0;
172}
173
174/**
175 * snd_dmaengine_pcm_trigger - dmaengine based PCM trigger implementation
176 * @substream: PCM substream
177 * @cmd: Trigger command
178 *
179 * Returns 0 on success, a negative error code otherwise.
180 *
181 * This function can be used as the PCM trigger callback for dmaengine based PCM
182 * driver implementations.
183 */
184int snd_dmaengine_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
185{
186 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
Tushar Behera02fb05a2014-05-19 14:53:53 +0530187 struct snd_pcm_runtime *runtime = substream->runtime;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100188 int ret;
189
190 switch (cmd) {
191 case SNDRV_PCM_TRIGGER_START:
192 ret = dmaengine_pcm_prepare_and_submit(substream);
193 if (ret)
194 return ret;
195 dma_async_issue_pending(prtd->dma_chan);
196 break;
197 case SNDRV_PCM_TRIGGER_RESUME:
198 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
199 dmaengine_resume(prtd->dma_chan);
200 break;
201 case SNDRV_PCM_TRIGGER_SUSPEND:
Tushar Behera02fb05a2014-05-19 14:53:53 +0530202 if (runtime->info & SNDRV_PCM_INFO_PAUSE)
203 dmaengine_pause(prtd->dma_chan);
204 else
Lars-Peter Clausenbc0e7342015-10-20 11:46:31 +0200205 dmaengine_terminate_async(prtd->dma_chan);
Tushar Behera02fb05a2014-05-19 14:53:53 +0530206 break;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100207 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
208 dmaengine_pause(prtd->dma_chan);
209 break;
210 case SNDRV_PCM_TRIGGER_STOP:
Lars-Peter Clausenbc0e7342015-10-20 11:46:31 +0200211 dmaengine_terminate_async(prtd->dma_chan);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100212 break;
213 default:
214 return -EINVAL;
215 }
216
217 return 0;
218}
219EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_trigger);
220
221/**
Lars-Peter Clausen9883ab22012-06-11 20:11:41 +0200222 * snd_dmaengine_pcm_pointer_no_residue - dmaengine based PCM pointer implementation
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100223 * @substream: PCM substream
224 *
Lars-Peter Clausen9883ab22012-06-11 20:11:41 +0200225 * This function is deprecated and should not be used by new drivers, as its
226 * results may be unreliable.
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100227 */
Lars-Peter Clausen9883ab22012-06-11 20:11:41 +0200228snd_pcm_uframes_t snd_dmaengine_pcm_pointer_no_residue(struct snd_pcm_substream *substream)
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100229{
230 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
231 return bytes_to_frames(substream->runtime, prtd->pos);
232}
Lars-Peter Clausen9883ab22012-06-11 20:11:41 +0200233EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_pointer_no_residue);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100234
Lars-Peter Clausen3528f272012-06-11 20:11:42 +0200235/**
236 * snd_dmaengine_pcm_pointer - dmaengine based PCM pointer implementation
237 * @substream: PCM substream
238 *
239 * This function can be used as the PCM pointer callback for dmaengine based PCM
240 * driver implementations.
241 */
242snd_pcm_uframes_t snd_dmaengine_pcm_pointer(struct snd_pcm_substream *substream)
243{
244 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
245 struct dma_tx_state state;
246 enum dma_status status;
247 unsigned int buf_size;
248 unsigned int pos = 0;
249
250 status = dmaengine_tx_status(prtd->dma_chan, prtd->cookie, &state);
251 if (status == DMA_IN_PROGRESS || status == DMA_PAUSED) {
252 buf_size = snd_pcm_lib_buffer_bytes(substream);
253 if (state.residue > 0 && state.residue <= buf_size)
254 pos = buf_size - state.residue;
255 }
256
257 return bytes_to_frames(substream->runtime, pos);
258}
259EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_pointer);
260
Lars-Peter Clausenc9998362013-04-15 19:19:51 +0200261/**
262 * snd_dmaengine_pcm_request_channel - Request channel for the dmaengine PCM
263 * @filter_fn: Filter function used to request the DMA channel
264 * @filter_data: Data passed to the DMA filter function
265 *
266 * Returns NULL or the requested DMA channel.
267 *
268 * This function request a DMA channel for usage with dmaengine PCM.
269 */
270struct dma_chan *snd_dmaengine_pcm_request_channel(dma_filter_fn filter_fn,
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200271 void *filter_data)
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100272{
273 dma_cap_mask_t mask;
274
275 dma_cap_zero(mask);
276 dma_cap_set(DMA_SLAVE, mask);
277 dma_cap_set(DMA_CYCLIC, mask);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100278
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200279 return dma_request_channel(mask, filter_fn, filter_data);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100280}
Lars-Peter Clausenc9998362013-04-15 19:19:51 +0200281EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_request_channel);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100282
283/**
284 * snd_dmaengine_pcm_open - Open a dmaengine based PCM substream
285 * @substream: PCM substream
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200286 * @chan: DMA channel to use for data transfers
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100287 *
288 * Returns 0 on success, a negative error code otherwise.
289 *
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200290 * The function should usually be called from the pcm open callback. Note that
291 * this function will use private_data field of the substream's runtime. So it
Masanari Iida1a6ab462015-03-04 10:56:13 +0900292 * is not available to your pcm driver implementation.
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100293 */
294int snd_dmaengine_pcm_open(struct snd_pcm_substream *substream,
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200295 struct dma_chan *chan)
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100296{
297 struct dmaengine_pcm_runtime_data *prtd;
298 int ret;
299
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200300 if (!chan)
301 return -ENXIO;
302
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100303 ret = snd_pcm_hw_constraint_integer(substream->runtime,
304 SNDRV_PCM_HW_PARAM_PERIODS);
305 if (ret < 0)
306 return ret;
307
308 prtd = kzalloc(sizeof(*prtd), GFP_KERNEL);
309 if (!prtd)
310 return -ENOMEM;
311
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200312 prtd->dma_chan = chan;
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100313
314 substream->runtime->private_data = prtd;
315
316 return 0;
317}
318EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_open);
319
320/**
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200321 * snd_dmaengine_pcm_open_request_chan - Open a dmaengine based PCM substream and request channel
322 * @substream: PCM substream
323 * @filter_fn: Filter function used to request the DMA channel
324 * @filter_data: Data passed to the DMA filter function
325 *
326 * Returns 0 on success, a negative error code otherwise.
327 *
328 * This function will request a DMA channel using the passed filter function and
329 * data. The function should usually be called from the pcm open callback. Note
330 * that this function will use private_data field of the substream's runtime. So
Masanari Iida1a6ab462015-03-04 10:56:13 +0900331 * it is not available to your pcm driver implementation.
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200332 */
333int snd_dmaengine_pcm_open_request_chan(struct snd_pcm_substream *substream,
334 dma_filter_fn filter_fn, void *filter_data)
335{
336 return snd_dmaengine_pcm_open(substream,
Lars-Peter Clausenc9998362013-04-15 19:19:51 +0200337 snd_dmaengine_pcm_request_channel(filter_fn, filter_data));
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200338}
339EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_open_request_chan);
340
341/**
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100342 * snd_dmaengine_pcm_close - Close a dmaengine based PCM substream
343 * @substream: PCM substream
344 */
345int snd_dmaengine_pcm_close(struct snd_pcm_substream *substream)
346{
347 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
348
Lars-Peter Clausenbc0e7342015-10-20 11:46:31 +0200349 dmaengine_synchronize(prtd->dma_chan);
Lars-Peter Clausene7f73a12012-02-22 10:49:08 +0100350 kfree(prtd);
351
352 return 0;
353}
354EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_close);
Lothar Waßmanncba69b42012-11-22 13:31:10 +0100355
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200356/**
357 * snd_dmaengine_pcm_release_chan_close - Close a dmaengine based PCM substream and release channel
358 * @substream: PCM substream
359 *
360 * Releases the DMA channel associated with the PCM substream.
361 */
362int snd_dmaengine_pcm_close_release_chan(struct snd_pcm_substream *substream)
363{
364 struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
365
Lars-Peter Clausenbc0e7342015-10-20 11:46:31 +0200366 dmaengine_synchronize(prtd->dma_chan);
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200367 dma_release_channel(prtd->dma_chan);
Lars-Peter Clausenbc0e7342015-10-20 11:46:31 +0200368 kfree(prtd);
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200369
Lars-Peter Clausenbc0e7342015-10-20 11:46:31 +0200370 return 0;
Lars-Peter Clausen7c1c1d42013-04-15 19:19:48 +0200371}
372EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_close_release_chan);
373
Lothar Waßmanncba69b42012-11-22 13:31:10 +0100374MODULE_LICENSE("GPL");