asoc: tegra: Enable ULP audio
[linux-3.10.git] / sound / soc / soc-dmaengine-pcm.c
1 /*
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
31 struct dmaengine_pcm_runtime_data {
32         struct dma_chan *dma_chan;
33         dma_cookie_t cookie;
34
35         unsigned int pos;
36
37         void *data;
38 };
39
40 static inline struct dmaengine_pcm_runtime_data *substream_to_prtd(
41         const struct snd_pcm_substream *substream)
42 {
43         return substream->runtime->private_data;
44 }
45
46 /**
47  * snd_dmaengine_pcm_set_data - Set dmaengine substream private data
48  * @substream: PCM substream
49  * @data: Data to set
50  */
51 void snd_dmaengine_pcm_set_data(struct snd_pcm_substream *substream, void *data)
52 {
53         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
54
55         prtd->data = data;
56 }
57 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_set_data);
58
59 /**
60  * snd_dmaengine_pcm_get_data - Get dmaeinge substream private data
61  * @substream: PCM substream
62  *
63  * Returns the data previously set with snd_dmaengine_pcm_set_data
64  */
65 void *snd_dmaengine_pcm_get_data(struct snd_pcm_substream *substream)
66 {
67         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
68
69         return prtd->data;
70 }
71 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_get_data);
72
73 struct dma_chan *snd_dmaengine_pcm_get_chan(struct snd_pcm_substream *substream)
74 {
75         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
76
77         return prtd->dma_chan;
78 }
79 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_get_chan);
80
81 /**
82  * snd_hwparams_to_dma_slave_config - Convert hw_params to dma_slave_config
83  * @substream: PCM substream
84  * @params: hw_params
85  * @slave_config: DMA slave config
86  *
87  * This function can be used to initialize a dma_slave_config from a substream
88  * and hw_params in a dmaengine based PCM driver implementation.
89  */
90 int snd_hwparams_to_dma_slave_config(const struct snd_pcm_substream *substream,
91         const struct snd_pcm_hw_params *params,
92         struct dma_slave_config *slave_config)
93 {
94         enum dma_slave_buswidth buswidth;
95
96         switch (params_format(params)) {
97         case SNDRV_PCM_FORMAT_S8:
98                 buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE;
99                 break;
100         case SNDRV_PCM_FORMAT_S16_LE:
101                 buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
102                 break;
103         case SNDRV_PCM_FORMAT_S18_3LE:
104         case SNDRV_PCM_FORMAT_S20_3LE:
105         case SNDRV_PCM_FORMAT_S24_LE:
106         case SNDRV_PCM_FORMAT_S32_LE:
107                 buswidth = DMA_SLAVE_BUSWIDTH_4_BYTES;
108                 break;
109         default:
110                 return -EINVAL;
111         }
112
113         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
114                 slave_config->direction = DMA_MEM_TO_DEV;
115                 slave_config->dst_addr_width = buswidth;
116         } else {
117                 slave_config->direction = DMA_DEV_TO_MEM;
118                 slave_config->src_addr_width = buswidth;
119         }
120
121         slave_config->device_fc = false;
122
123         return 0;
124 }
125 EXPORT_SYMBOL_GPL(snd_hwparams_to_dma_slave_config);
126
127 /**
128  * snd_dmaengine_pcm_set_config_from_dai_data() - Initializes a dma slave config
129  *  using DAI DMA data.
130  * @substream: PCM substream
131  * @dma_data: DAI DMA data
132  * @slave_config: DMA slave configuration
133  *
134  * Initializes the {dst,src}_addr, {dst,src}_maxburst, {dst,src}_addr_width and
135  * slave_id fields of the DMA slave config from the same fields of the DAI DMA
136  * data struct. The src and dst fields will be initialized depending on the
137  * direction of the substream. If the substream is a playback stream the dst
138  * fields will be initialized, if it is a capture stream the src fields will be
139  * initialized. The {dst,src}_addr_width field will only be initialized if the
140  * addr_width field of the DAI DMA data struct is not equal to
141  * DMA_SLAVE_BUSWIDTH_UNDEFINED.
142  */
143 void snd_dmaengine_pcm_set_config_from_dai_data(
144         const struct snd_pcm_substream *substream,
145         const struct snd_dmaengine_dai_dma_data *dma_data,
146         struct dma_slave_config *slave_config)
147 {
148         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
149                 slave_config->dst_addr = dma_data->addr;
150                 slave_config->dst_maxburst = dma_data->maxburst;
151                 if (dma_data->addr_width != DMA_SLAVE_BUSWIDTH_UNDEFINED)
152                         slave_config->dst_addr_width = dma_data->addr_width;
153         } else {
154                 slave_config->src_addr = dma_data->addr;
155                 slave_config->src_maxburst = dma_data->maxburst;
156                 if (dma_data->addr_width != DMA_SLAVE_BUSWIDTH_UNDEFINED)
157                         slave_config->src_addr_width = dma_data->addr_width;
158         }
159
160         slave_config->slave_id = dma_data->slave_id;
161 }
162 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_set_config_from_dai_data);
163
164 static void dmaengine_pcm_dma_complete(void *arg)
165 {
166         struct snd_pcm_substream *substream = arg;
167         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
168
169         prtd->pos += snd_pcm_lib_period_bytes(substream);
170         if (prtd->pos >= snd_pcm_lib_buffer_bytes(substream))
171                 prtd->pos = 0;
172
173         snd_pcm_period_elapsed(substream);
174 }
175
176 static int dmaengine_pcm_prepare_and_submit(struct snd_pcm_substream *substream)
177 {
178         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
179         struct dma_chan *chan = prtd->dma_chan;
180         struct dma_async_tx_descriptor *desc;
181         enum dma_transfer_direction direction;
182         unsigned long flags = DMA_CTRL_ACK;
183
184         direction = snd_pcm_substream_to_dma_direction(substream);
185
186         if (!substream->runtime->no_period_wakeup)
187                 flags |= DMA_PREP_INTERRUPT;
188
189         prtd->pos = 0;
190         desc = dmaengine_prep_dma_cyclic(chan,
191                 substream->runtime->dma_addr,
192                 snd_pcm_lib_buffer_bytes(substream),
193                 snd_pcm_lib_period_bytes(substream), direction, flags);
194
195         if (!desc)
196                 return -ENOMEM;
197
198         desc->callback = dmaengine_pcm_dma_complete;
199         desc->callback_param = substream;
200         prtd->cookie = dmaengine_submit(desc);
201
202         return 0;
203 }
204
205 /**
206  * snd_dmaengine_pcm_trigger - dmaengine based PCM trigger implementation
207  * @substream: PCM substream
208  * @cmd: Trigger command
209  *
210  * Returns 0 on success, a negative error code otherwise.
211  *
212  * This function can be used as the PCM trigger callback for dmaengine based PCM
213  * driver implementations.
214  */
215 int snd_dmaengine_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
216 {
217         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
218         int ret;
219
220         switch (cmd) {
221         case SNDRV_PCM_TRIGGER_START:
222                 ret = dmaengine_pcm_prepare_and_submit(substream);
223                 if (ret)
224                         return ret;
225                 dma_async_issue_pending(prtd->dma_chan);
226                 break;
227         case SNDRV_PCM_TRIGGER_RESUME:
228         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
229                 dmaengine_resume(prtd->dma_chan);
230                 break;
231         case SNDRV_PCM_TRIGGER_SUSPEND:
232         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
233                 dmaengine_pause(prtd->dma_chan);
234                 break;
235         case SNDRV_PCM_TRIGGER_STOP:
236                 dmaengine_terminate_all(prtd->dma_chan);
237                 break;
238         default:
239                 return -EINVAL;
240         }
241
242         return 0;
243 }
244 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_trigger);
245
246 /**
247  * snd_dmaengine_pcm_pointer_no_residue - dmaengine based PCM pointer implementation
248  * @substream: PCM substream
249  *
250  * This function is deprecated and should not be used by new drivers, as its
251  * results may be unreliable.
252  */
253 snd_pcm_uframes_t snd_dmaengine_pcm_pointer_no_residue(struct snd_pcm_substream *substream)
254 {
255         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
256         return bytes_to_frames(substream->runtime, prtd->pos);
257 }
258 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_pointer_no_residue);
259
260 /**
261  * snd_dmaengine_pcm_pointer - dmaengine based PCM pointer implementation
262  * @substream: PCM substream
263  *
264  * This function can be used as the PCM pointer callback for dmaengine based PCM
265  * driver implementations.
266  */
267 snd_pcm_uframes_t snd_dmaengine_pcm_pointer(struct snd_pcm_substream *substream)
268 {
269         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
270         struct dma_tx_state state;
271         enum dma_status status;
272         unsigned int buf_size;
273         unsigned int pos = 0;
274
275         status = dmaengine_tx_status(prtd->dma_chan, prtd->cookie, &state);
276         if (status == DMA_IN_PROGRESS || status == DMA_PAUSED) {
277                 buf_size = snd_pcm_lib_buffer_bytes(substream);
278                 if (state.residue > 0 && state.residue <= buf_size)
279                         pos = buf_size - state.residue;
280         }
281
282         return bytes_to_frames(substream->runtime, pos);
283 }
284 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_pointer);
285
286 /**
287  * snd_dmaengine_pcm_request_channel - Request channel for the dmaengine PCM
288  * @filter_fn: Filter function used to request the DMA channel
289  * @filter_data: Data passed to the DMA filter function
290  *
291  * Returns NULL or the requested DMA channel.
292  *
293  * This function request a DMA channel for usage with dmaengine PCM.
294  */
295 struct dma_chan *snd_dmaengine_pcm_request_channel(dma_filter_fn filter_fn,
296         void *filter_data)
297 {
298         dma_cap_mask_t mask;
299
300         dma_cap_zero(mask);
301         dma_cap_set(DMA_SLAVE, mask);
302         dma_cap_set(DMA_CYCLIC, mask);
303
304         return dma_request_channel(mask, filter_fn, filter_data);
305 }
306 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_request_channel);
307
308 /**
309  * snd_dmaengine_pcm_open - Open a dmaengine based PCM substream
310  * @substream: PCM substream
311  * @chan: DMA channel to use for data transfers
312  *
313  * Returns 0 on success, a negative error code otherwise.
314  *
315  * The function should usually be called from the pcm open callback. Note that
316  * this function will use private_data field of the substream's runtime. So it
317  * is not availabe to your pcm driver implementation.
318  */
319 int snd_dmaengine_pcm_open(struct snd_pcm_substream *substream,
320         struct dma_chan *chan)
321 {
322         struct dmaengine_pcm_runtime_data *prtd;
323         int ret;
324
325         if (!chan)
326                 return -ENXIO;
327
328         ret = snd_pcm_hw_constraint_integer(substream->runtime,
329                                             SNDRV_PCM_HW_PARAM_PERIODS);
330         if (ret < 0)
331                 return ret;
332
333         prtd = kzalloc(sizeof(*prtd), GFP_KERNEL);
334         if (!prtd)
335                 return -ENOMEM;
336
337         prtd->dma_chan = chan;
338
339         substream->runtime->private_data = prtd;
340
341         return 0;
342 }
343 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_open);
344
345 /**
346  * snd_dmaengine_pcm_open_request_chan - Open a dmaengine based PCM substream and request channel
347  * @substream: PCM substream
348  * @filter_fn: Filter function used to request the DMA channel
349  * @filter_data: Data passed to the DMA filter function
350  *
351  * Returns 0 on success, a negative error code otherwise.
352  *
353  * This function will request a DMA channel using the passed filter function and
354  * data. The function should usually be called from the pcm open callback. Note
355  * that this function will use private_data field of the substream's runtime. So
356  * it is not availabe to your pcm driver implementation.
357  */
358 int snd_dmaengine_pcm_open_request_chan(struct snd_pcm_substream *substream,
359         dma_filter_fn filter_fn, void *filter_data)
360 {
361         return snd_dmaengine_pcm_open(substream,
362                     snd_dmaengine_pcm_request_channel(filter_fn, filter_data));
363 }
364 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_open_request_chan);
365
366 /**
367  * snd_dmaengine_pcm_close - Close a dmaengine based PCM substream
368  * @substream: PCM substream
369  */
370 int snd_dmaengine_pcm_close(struct snd_pcm_substream *substream)
371 {
372         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
373
374         kfree(prtd);
375
376         return 0;
377 }
378 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_close);
379
380 /**
381  * snd_dmaengine_pcm_release_chan_close - Close a dmaengine based PCM substream and release channel
382  * @substream: PCM substream
383  *
384  * Releases the DMA channel associated with the PCM substream.
385  */
386 int snd_dmaengine_pcm_close_release_chan(struct snd_pcm_substream *substream)
387 {
388         struct dmaengine_pcm_runtime_data *prtd = substream_to_prtd(substream);
389
390         dma_release_channel(prtd->dma_chan);
391
392         return snd_dmaengine_pcm_close(substream);
393 }
394 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_close_release_chan);
395
396 MODULE_LICENSE("GPL");