[ALSA] Move OSS-specific hw_params helper to snd-pcm-oss module
[linux-2.6.git] / sound / core / pcm_memory.c
1 /*
2  *  Digital Audio (PCM) abstract layer
3  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
4  *
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  *
20  */
21
22 #include <sound/driver.h>
23 #include <asm/io.h>
24 #include <linux/time.h>
25 #include <linux/init.h>
26 #include <linux/moduleparam.h>
27 #include <sound/core.h>
28 #include <sound/pcm.h>
29 #include <sound/info.h>
30 #include <sound/initval.h>
31
32 static int preallocate_dma = 1;
33 module_param(preallocate_dma, int, 0444);
34 MODULE_PARM_DESC(preallocate_dma, "Preallocate DMA memory when the PCM devices are initialized.");
35
36 static int maximum_substreams = 4;
37 module_param(maximum_substreams, int, 0444);
38 MODULE_PARM_DESC(maximum_substreams, "Maximum substreams with preallocated DMA memory.");
39
40 static const size_t snd_minimum_buffer = 16384;
41
42
43 /*
44  * try to allocate as the large pages as possible.
45  * stores the resultant memory size in *res_size.
46  *
47  * the minimum size is snd_minimum_buffer.  it should be power of 2.
48  */
49 static int preallocate_pcm_pages(struct snd_pcm_substream *substream, size_t size)
50 {
51         struct snd_dma_buffer *dmab = &substream->dma_buffer;
52         int err;
53
54         snd_assert(size > 0, return -EINVAL);
55
56         /* already reserved? */
57         if (snd_dma_get_reserved_buf(dmab, substream->dma_buf_id) > 0) {
58                 if (dmab->bytes >= size)
59                         return 0; /* yes */
60                 /* no, free the reserved block */
61                 snd_dma_free_pages(dmab);
62                 dmab->bytes = 0;
63         }
64
65         do {
66                 if ((err = snd_dma_alloc_pages(dmab->dev.type, dmab->dev.dev,
67                                                size, dmab)) < 0) {
68                         if (err != -ENOMEM)
69                                 return err; /* fatal error */
70                 } else
71                         return 0;
72                 size >>= 1;
73         } while (size >= snd_minimum_buffer);
74         dmab->bytes = 0; /* tell error */
75         return 0;
76 }
77
78 /*
79  * release the preallocated buffer if not yet done.
80  */
81 static void snd_pcm_lib_preallocate_dma_free(struct snd_pcm_substream *substream)
82 {
83         if (substream->dma_buffer.area == NULL)
84                 return;
85         if (substream->dma_buf_id)
86                 snd_dma_reserve_buf(&substream->dma_buffer, substream->dma_buf_id);
87         else
88                 snd_dma_free_pages(&substream->dma_buffer);
89         substream->dma_buffer.area = NULL;
90 }
91
92 /**
93  * snd_pcm_lib_preallocate_free - release the preallocated buffer of the specified substream.
94  * @substream: the pcm substream instance
95  *
96  * Releases the pre-allocated buffer of the given substream.
97  *
98  * Returns zero if successful, or a negative error code on failure.
99  */
100 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream)
101 {
102         snd_pcm_lib_preallocate_dma_free(substream);
103 #ifdef CONFIG_SND_VERBOSE_PROCFS
104         snd_info_unregister(substream->proc_prealloc_entry);
105         substream->proc_prealloc_entry = NULL;
106 #endif
107         return 0;
108 }
109
110 /**
111  * snd_pcm_lib_preallocate_free_for_all - release all pre-allocated buffers on the pcm
112  * @pcm: the pcm instance
113  *
114  * Releases all the pre-allocated buffers on the given pcm.
115  *
116  * Returns zero if successful, or a negative error code on failure.
117  */
118 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm)
119 {
120         struct snd_pcm_substream *substream;
121         int stream;
122
123         for (stream = 0; stream < 2; stream++)
124                 for (substream = pcm->streams[stream].substream; substream; substream = substream->next)
125                         snd_pcm_lib_preallocate_free(substream);
126         return 0;
127 }
128
129 EXPORT_SYMBOL(snd_pcm_lib_preallocate_free_for_all);
130
131 #ifdef CONFIG_SND_VERBOSE_PROCFS
132 /*
133  * read callback for prealloc proc file
134  *
135  * prints the current allocated size in kB.
136  */
137 static void snd_pcm_lib_preallocate_proc_read(struct snd_info_entry *entry,
138                                               struct snd_info_buffer *buffer)
139 {
140         struct snd_pcm_substream *substream = entry->private_data;
141         snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_buffer.bytes / 1024);
142 }
143
144 /*
145  * write callback for prealloc proc file
146  *
147  * accepts the preallocation size in kB.
148  */
149 static void snd_pcm_lib_preallocate_proc_write(struct snd_info_entry *entry,
150                                                struct snd_info_buffer *buffer)
151 {
152         struct snd_pcm_substream *substream = entry->private_data;
153         char line[64], str[64];
154         size_t size;
155         struct snd_dma_buffer new_dmab;
156
157         if (substream->runtime) {
158                 buffer->error = -EBUSY;
159                 return;
160         }
161         if (!snd_info_get_line(buffer, line, sizeof(line))) {
162                 snd_info_get_str(str, line, sizeof(str));
163                 size = simple_strtoul(str, NULL, 10) * 1024;
164                 if ((size != 0 && size < 8192) || size > substream->dma_max) {
165                         buffer->error = -EINVAL;
166                         return;
167                 }
168                 if (substream->dma_buffer.bytes == size)
169                         return;
170                 memset(&new_dmab, 0, sizeof(new_dmab));
171                 new_dmab.dev = substream->dma_buffer.dev;
172                 if (size > 0) {
173                         if (snd_dma_alloc_pages(substream->dma_buffer.dev.type,
174                                                 substream->dma_buffer.dev.dev,
175                                                 size, &new_dmab) < 0) {
176                                 buffer->error = -ENOMEM;
177                                 return;
178                         }
179                         substream->buffer_bytes_max = size;
180                 } else {
181                         substream->buffer_bytes_max = UINT_MAX;
182                 }
183                 if (substream->dma_buffer.area)
184                         snd_dma_free_pages(&substream->dma_buffer);
185                 substream->dma_buffer = new_dmab;
186         } else {
187                 buffer->error = -EINVAL;
188         }
189 }
190
191 static inline void preallocate_info_init(struct snd_pcm_substream *substream)
192 {
193         struct snd_info_entry *entry;
194
195         if ((entry = snd_info_create_card_entry(substream->pcm->card, "prealloc", substream->proc_root)) != NULL) {
196                 entry->c.text.read_size = 64;
197                 entry->c.text.read = snd_pcm_lib_preallocate_proc_read;
198                 entry->c.text.write_size = 64;
199                 entry->c.text.write = snd_pcm_lib_preallocate_proc_write;
200                 entry->mode |= S_IWUSR;
201                 entry->private_data = substream;
202                 if (snd_info_register(entry) < 0) {
203                         snd_info_free_entry(entry);
204                         entry = NULL;
205                 }
206         }
207         substream->proc_prealloc_entry = entry;
208 }
209
210 #else /* !CONFIG_SND_VERBOSE_PROCFS */
211 #define preallocate_info_init(s)
212 #endif /* CONFIG_SND_VERBOSE_PROCFS */
213
214 /*
215  * pre-allocate the buffer and create a proc file for the substream
216  */
217 static int snd_pcm_lib_preallocate_pages1(struct snd_pcm_substream *substream,
218                                           size_t size, size_t max)
219 {
220
221         if (size > 0 && preallocate_dma && substream->number < maximum_substreams)
222                 preallocate_pcm_pages(substream, size);
223
224         if (substream->dma_buffer.bytes > 0)
225                 substream->buffer_bytes_max = substream->dma_buffer.bytes;
226         substream->dma_max = max;
227         preallocate_info_init(substream);
228         return 0;
229 }
230
231
232 /**
233  * snd_pcm_lib_preallocate_pages - pre-allocation for the given DMA type
234  * @substream: the pcm substream instance
235  * @type: DMA type (SNDRV_DMA_TYPE_*)
236  * @data: DMA type dependant data
237  * @size: the requested pre-allocation size in bytes
238  * @max: the max. allowed pre-allocation size
239  *
240  * Do pre-allocation for the given DMA buffer type.
241  *
242  * When substream->dma_buf_id is set, the function tries to look for
243  * the reserved buffer, and the buffer is not freed but reserved at
244  * destruction time.  The dma_buf_id must be unique for all systems
245  * (in the same DMA buffer type) e.g. using snd_dma_pci_buf_id().
246  *
247  * Returns zero if successful, or a negative error code on failure.
248  */
249 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
250                                   int type, struct device *data,
251                                   size_t size, size_t max)
252 {
253         substream->dma_buffer.dev.type = type;
254         substream->dma_buffer.dev.dev = data;
255         return snd_pcm_lib_preallocate_pages1(substream, size, max);
256 }
257
258 EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages);
259
260 /**
261  * snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continous memory type (all substreams)
262  * @pcm: the pcm instance
263  * @type: DMA type (SNDRV_DMA_TYPE_*)
264  * @data: DMA type dependant data
265  * @size: the requested pre-allocation size in bytes
266  * @max: the max. allowed pre-allocation size
267  *
268  * Do pre-allocation to all substreams of the given pcm for the
269  * specified DMA type.
270  *
271  * Returns zero if successful, or a negative error code on failure.
272  */
273 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
274                                           int type, void *data,
275                                           size_t size, size_t max)
276 {
277         struct snd_pcm_substream *substream;
278         int stream, err;
279
280         for (stream = 0; stream < 2; stream++)
281                 for (substream = pcm->streams[stream].substream; substream; substream = substream->next)
282                         if ((err = snd_pcm_lib_preallocate_pages(substream, type, data, size, max)) < 0)
283                                 return err;
284         return 0;
285 }
286
287 EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages_for_all);
288
289 /**
290  * snd_pcm_sgbuf_ops_page - get the page struct at the given offset
291  * @substream: the pcm substream instance
292  * @offset: the buffer offset
293  *
294  * Returns the page struct at the given buffer offset.
295  * Used as the page callback of PCM ops.
296  */
297 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset)
298 {
299         struct snd_sg_buf *sgbuf = snd_pcm_substream_sgbuf(substream);
300
301         unsigned int idx = offset >> PAGE_SHIFT;
302         if (idx >= (unsigned int)sgbuf->pages)
303                 return NULL;
304         return sgbuf->page_table[idx];
305 }
306
307 EXPORT_SYMBOL(snd_pcm_sgbuf_ops_page);
308
309 /**
310  * snd_pcm_lib_malloc_pages - allocate the DMA buffer
311  * @substream: the substream to allocate the DMA buffer to
312  * @size: the requested buffer size in bytes
313  *
314  * Allocates the DMA buffer on the BUS type given earlier to
315  * snd_pcm_lib_preallocate_xxx_pages().
316  *
317  * Returns 1 if the buffer is changed, 0 if not changed, or a negative
318  * code on failure.
319  */
320 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size)
321 {
322         struct snd_pcm_runtime *runtime;
323         struct snd_dma_buffer *dmab = NULL;
324
325         snd_assert(substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_UNKNOWN, return -EINVAL);
326         snd_assert(substream != NULL, return -EINVAL);
327         runtime = substream->runtime;
328         snd_assert(runtime != NULL, return -EINVAL);
329
330         if (runtime->dma_buffer_p) {
331                 /* perphaps, we might free the large DMA memory region
332                    to save some space here, but the actual solution
333                    costs us less time */
334                 if (runtime->dma_buffer_p->bytes >= size) {
335                         runtime->dma_bytes = size;
336                         return 0;       /* ok, do not change */
337                 }
338                 snd_pcm_lib_free_pages(substream);
339         }
340         if (substream->dma_buffer.area != NULL &&
341             substream->dma_buffer.bytes >= size) {
342                 dmab = &substream->dma_buffer; /* use the pre-allocated buffer */
343         } else {
344                 dmab = kzalloc(sizeof(*dmab), GFP_KERNEL);
345                 if (! dmab)
346                         return -ENOMEM;
347                 dmab->dev = substream->dma_buffer.dev;
348                 if (snd_dma_alloc_pages(substream->dma_buffer.dev.type,
349                                         substream->dma_buffer.dev.dev,
350                                         size, dmab) < 0) {
351                         kfree(dmab);
352                         return -ENOMEM;
353                 }
354         }
355         snd_pcm_set_runtime_buffer(substream, dmab);
356         runtime->dma_bytes = size;
357         return 1;                       /* area was changed */
358 }
359
360 EXPORT_SYMBOL(snd_pcm_lib_malloc_pages);
361
362 /**
363  * snd_pcm_lib_free_pages - release the allocated DMA buffer.
364  * @substream: the substream to release the DMA buffer
365  *
366  * Releases the DMA buffer allocated via snd_pcm_lib_malloc_pages().
367  *
368  * Returns zero if successful, or a negative error code on failure.
369  */
370 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream)
371 {
372         struct snd_pcm_runtime *runtime;
373
374         snd_assert(substream != NULL, return -EINVAL);
375         runtime = substream->runtime;
376         snd_assert(runtime != NULL, return -EINVAL);
377         if (runtime->dma_area == NULL)
378                 return 0;
379         if (runtime->dma_buffer_p != &substream->dma_buffer) {
380                 /* it's a newly allocated buffer.  release it now. */
381                 snd_dma_free_pages(runtime->dma_buffer_p);
382                 kfree(runtime->dma_buffer_p);
383         }
384         snd_pcm_set_runtime_buffer(substream, NULL);
385         return 0;
386 }
387
388 EXPORT_SYMBOL(snd_pcm_lib_free_pages);