Loading...
1/*
2 * Digital Audio (PCM) abstract layer
3 * Copyright (c) by Jaroslav Kysela <perex@perex.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 <asm/io.h>
23#include <linux/time.h>
24#include <linux/init.h>
25#include <linux/slab.h>
26#include <linux/moduleparam.h>
27#include <linux/vmalloc.h>
28#include <linux/export.h>
29#include <sound/core.h>
30#include <sound/pcm.h>
31#include <sound/info.h>
32#include <sound/initval.h>
33
34static int preallocate_dma = 1;
35module_param(preallocate_dma, int, 0444);
36MODULE_PARM_DESC(preallocate_dma, "Preallocate DMA memory when the PCM devices are initialized.");
37
38static int maximum_substreams = 4;
39module_param(maximum_substreams, int, 0444);
40MODULE_PARM_DESC(maximum_substreams, "Maximum substreams with preallocated DMA memory.");
41
42static const size_t snd_minimum_buffer = 16384;
43
44
45/*
46 * try to allocate as the large pages as possible.
47 * stores the resultant memory size in *res_size.
48 *
49 * the minimum size is snd_minimum_buffer. it should be power of 2.
50 */
51static int preallocate_pcm_pages(struct snd_pcm_substream *substream, size_t size)
52{
53 struct snd_dma_buffer *dmab = &substream->dma_buffer;
54 size_t orig_size = size;
55 int err;
56
57 do {
58 if ((err = snd_dma_alloc_pages(dmab->dev.type, dmab->dev.dev,
59 size, dmab)) < 0) {
60 if (err != -ENOMEM)
61 return err; /* fatal error */
62 } else
63 return 0;
64 size >>= 1;
65 } while (size >= snd_minimum_buffer);
66 dmab->bytes = 0; /* tell error */
67 pr_warn("ALSA pcmC%dD%d%c,%d:%s: cannot preallocate for size %zu\n",
68 substream->pcm->card->number, substream->pcm->device,
69 substream->stream ? 'c' : 'p', substream->number,
70 substream->pcm->name, orig_size);
71 return 0;
72}
73
74/*
75 * release the preallocated buffer if not yet done.
76 */
77static void snd_pcm_lib_preallocate_dma_free(struct snd_pcm_substream *substream)
78{
79 if (substream->dma_buffer.area == NULL)
80 return;
81 snd_dma_free_pages(&substream->dma_buffer);
82 substream->dma_buffer.area = NULL;
83}
84
85/**
86 * snd_pcm_lib_preallocate_free - release the preallocated buffer of the specified substream.
87 * @substream: the pcm substream instance
88 *
89 * Releases the pre-allocated buffer of the given substream.
90 *
91 * Return: Zero if successful, or a negative error code on failure.
92 */
93int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream)
94{
95 snd_pcm_lib_preallocate_dma_free(substream);
96#ifdef CONFIG_SND_VERBOSE_PROCFS
97 snd_info_free_entry(substream->proc_prealloc_max_entry);
98 substream->proc_prealloc_max_entry = NULL;
99 snd_info_free_entry(substream->proc_prealloc_entry);
100 substream->proc_prealloc_entry = NULL;
101#endif
102 return 0;
103}
104
105/**
106 * snd_pcm_lib_preallocate_free_for_all - release all pre-allocated buffers on the pcm
107 * @pcm: the pcm instance
108 *
109 * Releases all the pre-allocated buffers on the given pcm.
110 *
111 * Return: Zero if successful, or a negative error code on failure.
112 */
113int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm)
114{
115 struct snd_pcm_substream *substream;
116 int stream;
117
118 for (stream = 0; stream < 2; stream++)
119 for (substream = pcm->streams[stream].substream; substream; substream = substream->next)
120 snd_pcm_lib_preallocate_free(substream);
121 return 0;
122}
123
124EXPORT_SYMBOL(snd_pcm_lib_preallocate_free_for_all);
125
126#ifdef CONFIG_SND_VERBOSE_PROCFS
127/*
128 * read callback for prealloc proc file
129 *
130 * prints the current allocated size in kB.
131 */
132static void snd_pcm_lib_preallocate_proc_read(struct snd_info_entry *entry,
133 struct snd_info_buffer *buffer)
134{
135 struct snd_pcm_substream *substream = entry->private_data;
136 snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_buffer.bytes / 1024);
137}
138
139/*
140 * read callback for prealloc_max proc file
141 *
142 * prints the maximum allowed size in kB.
143 */
144static void snd_pcm_lib_preallocate_max_proc_read(struct snd_info_entry *entry,
145 struct snd_info_buffer *buffer)
146{
147 struct snd_pcm_substream *substream = entry->private_data;
148 snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_max / 1024);
149}
150
151/*
152 * write callback for prealloc proc file
153 *
154 * accepts the preallocation size in kB.
155 */
156static void snd_pcm_lib_preallocate_proc_write(struct snd_info_entry *entry,
157 struct snd_info_buffer *buffer)
158{
159 struct snd_pcm_substream *substream = entry->private_data;
160 char line[64], str[64];
161 size_t size;
162 struct snd_dma_buffer new_dmab;
163
164 if (substream->runtime) {
165 buffer->error = -EBUSY;
166 return;
167 }
168 if (!snd_info_get_line(buffer, line, sizeof(line))) {
169 snd_info_get_str(str, line, sizeof(str));
170 size = simple_strtoul(str, NULL, 10) * 1024;
171 if ((size != 0 && size < 8192) || size > substream->dma_max) {
172 buffer->error = -EINVAL;
173 return;
174 }
175 if (substream->dma_buffer.bytes == size)
176 return;
177 memset(&new_dmab, 0, sizeof(new_dmab));
178 new_dmab.dev = substream->dma_buffer.dev;
179 if (size > 0) {
180 if (snd_dma_alloc_pages(substream->dma_buffer.dev.type,
181 substream->dma_buffer.dev.dev,
182 size, &new_dmab) < 0) {
183 buffer->error = -ENOMEM;
184 return;
185 }
186 substream->buffer_bytes_max = size;
187 } else {
188 substream->buffer_bytes_max = UINT_MAX;
189 }
190 if (substream->dma_buffer.area)
191 snd_dma_free_pages(&substream->dma_buffer);
192 substream->dma_buffer = new_dmab;
193 } else {
194 buffer->error = -EINVAL;
195 }
196}
197
198static inline void preallocate_info_init(struct snd_pcm_substream *substream)
199{
200 struct snd_info_entry *entry;
201
202 if ((entry = snd_info_create_card_entry(substream->pcm->card, "prealloc", substream->proc_root)) != NULL) {
203 entry->c.text.read = snd_pcm_lib_preallocate_proc_read;
204 entry->c.text.write = snd_pcm_lib_preallocate_proc_write;
205 entry->mode |= S_IWUSR;
206 entry->private_data = substream;
207 if (snd_info_register(entry) < 0) {
208 snd_info_free_entry(entry);
209 entry = NULL;
210 }
211 }
212 substream->proc_prealloc_entry = entry;
213 if ((entry = snd_info_create_card_entry(substream->pcm->card, "prealloc_max", substream->proc_root)) != NULL) {
214 entry->c.text.read = snd_pcm_lib_preallocate_max_proc_read;
215 entry->private_data = substream;
216 if (snd_info_register(entry) < 0) {
217 snd_info_free_entry(entry);
218 entry = NULL;
219 }
220 }
221 substream->proc_prealloc_max_entry = entry;
222}
223
224#else /* !CONFIG_SND_VERBOSE_PROCFS */
225#define preallocate_info_init(s)
226#endif /* CONFIG_SND_VERBOSE_PROCFS */
227
228/*
229 * pre-allocate the buffer and create a proc file for the substream
230 */
231static int snd_pcm_lib_preallocate_pages1(struct snd_pcm_substream *substream,
232 size_t size, size_t max)
233{
234
235 if (size > 0 && preallocate_dma && substream->number < maximum_substreams)
236 preallocate_pcm_pages(substream, size);
237
238 if (substream->dma_buffer.bytes > 0)
239 substream->buffer_bytes_max = substream->dma_buffer.bytes;
240 substream->dma_max = max;
241 preallocate_info_init(substream);
242 return 0;
243}
244
245
246/**
247 * snd_pcm_lib_preallocate_pages - pre-allocation for the given DMA type
248 * @substream: the pcm substream instance
249 * @type: DMA type (SNDRV_DMA_TYPE_*)
250 * @data: DMA type dependent data
251 * @size: the requested pre-allocation size in bytes
252 * @max: the max. allowed pre-allocation size
253 *
254 * Do pre-allocation for the given DMA buffer type.
255 *
256 * Return: Zero if successful, or a negative error code on failure.
257 */
258int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
259 int type, struct device *data,
260 size_t size, size_t max)
261{
262 substream->dma_buffer.dev.type = type;
263 substream->dma_buffer.dev.dev = data;
264 return snd_pcm_lib_preallocate_pages1(substream, size, max);
265}
266
267EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages);
268
269/**
270 * snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continuous memory type (all substreams)
271 * @pcm: the pcm instance
272 * @type: DMA type (SNDRV_DMA_TYPE_*)
273 * @data: DMA type dependent data
274 * @size: the requested pre-allocation size in bytes
275 * @max: the max. allowed pre-allocation size
276 *
277 * Do pre-allocation to all substreams of the given pcm for the
278 * specified DMA type.
279 *
280 * Return: Zero if successful, or a negative error code on failure.
281 */
282int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
283 int type, void *data,
284 size_t size, size_t max)
285{
286 struct snd_pcm_substream *substream;
287 int stream, err;
288
289 for (stream = 0; stream < 2; stream++)
290 for (substream = pcm->streams[stream].substream; substream; substream = substream->next)
291 if ((err = snd_pcm_lib_preallocate_pages(substream, type, data, size, max)) < 0)
292 return err;
293 return 0;
294}
295
296EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages_for_all);
297
298#ifdef CONFIG_SND_DMA_SGBUF
299/**
300 * snd_pcm_sgbuf_ops_page - get the page struct at the given offset
301 * @substream: the pcm substream instance
302 * @offset: the buffer offset
303 *
304 * Used as the page callback of PCM ops.
305 *
306 * Return: The page struct at the given buffer offset. %NULL on failure.
307 */
308struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset)
309{
310 struct snd_sg_buf *sgbuf = snd_pcm_substream_sgbuf(substream);
311
312 unsigned int idx = offset >> PAGE_SHIFT;
313 if (idx >= (unsigned int)sgbuf->pages)
314 return NULL;
315 return sgbuf->page_table[idx];
316}
317
318EXPORT_SYMBOL(snd_pcm_sgbuf_ops_page);
319#endif /* CONFIG_SND_DMA_SGBUF */
320
321/**
322 * snd_pcm_lib_malloc_pages - allocate the DMA buffer
323 * @substream: the substream to allocate the DMA buffer to
324 * @size: the requested buffer size in bytes
325 *
326 * Allocates the DMA buffer on the BUS type given earlier to
327 * snd_pcm_lib_preallocate_xxx_pages().
328 *
329 * Return: 1 if the buffer is changed, 0 if not changed, or a negative
330 * code on failure.
331 */
332int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size)
333{
334 struct snd_pcm_runtime *runtime;
335 struct snd_dma_buffer *dmab = NULL;
336
337 if (PCM_RUNTIME_CHECK(substream))
338 return -EINVAL;
339 if (snd_BUG_ON(substream->dma_buffer.dev.type ==
340 SNDRV_DMA_TYPE_UNKNOWN))
341 return -EINVAL;
342 runtime = substream->runtime;
343
344 if (runtime->dma_buffer_p) {
345 /* perphaps, we might free the large DMA memory region
346 to save some space here, but the actual solution
347 costs us less time */
348 if (runtime->dma_buffer_p->bytes >= size) {
349 runtime->dma_bytes = size;
350 return 0; /* ok, do not change */
351 }
352 snd_pcm_lib_free_pages(substream);
353 }
354 if (substream->dma_buffer.area != NULL &&
355 substream->dma_buffer.bytes >= size) {
356 dmab = &substream->dma_buffer; /* use the pre-allocated buffer */
357 } else {
358 dmab = kzalloc(sizeof(*dmab), GFP_KERNEL);
359 if (! dmab)
360 return -ENOMEM;
361 dmab->dev = substream->dma_buffer.dev;
362 if (snd_dma_alloc_pages(substream->dma_buffer.dev.type,
363 substream->dma_buffer.dev.dev,
364 size, dmab) < 0) {
365 kfree(dmab);
366 return -ENOMEM;
367 }
368 }
369 snd_pcm_set_runtime_buffer(substream, dmab);
370 runtime->dma_bytes = size;
371 return 1; /* area was changed */
372}
373
374EXPORT_SYMBOL(snd_pcm_lib_malloc_pages);
375
376/**
377 * snd_pcm_lib_free_pages - release the allocated DMA buffer.
378 * @substream: the substream to release the DMA buffer
379 *
380 * Releases the DMA buffer allocated via snd_pcm_lib_malloc_pages().
381 *
382 * Return: Zero if successful, or a negative error code on failure.
383 */
384int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream)
385{
386 struct snd_pcm_runtime *runtime;
387
388 if (PCM_RUNTIME_CHECK(substream))
389 return -EINVAL;
390 runtime = substream->runtime;
391 if (runtime->dma_area == NULL)
392 return 0;
393 if (runtime->dma_buffer_p != &substream->dma_buffer) {
394 /* it's a newly allocated buffer. release it now. */
395 snd_dma_free_pages(runtime->dma_buffer_p);
396 kfree(runtime->dma_buffer_p);
397 }
398 snd_pcm_set_runtime_buffer(substream, NULL);
399 return 0;
400}
401
402EXPORT_SYMBOL(snd_pcm_lib_free_pages);
403
404int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
405 size_t size, gfp_t gfp_flags)
406{
407 struct snd_pcm_runtime *runtime;
408
409 if (PCM_RUNTIME_CHECK(substream))
410 return -EINVAL;
411 runtime = substream->runtime;
412 if (runtime->dma_area) {
413 if (runtime->dma_bytes >= size)
414 return 0; /* already large enough */
415 vfree(runtime->dma_area);
416 }
417 runtime->dma_area = __vmalloc(size, gfp_flags, PAGE_KERNEL);
418 if (!runtime->dma_area)
419 return -ENOMEM;
420 runtime->dma_bytes = size;
421 return 1;
422}
423EXPORT_SYMBOL(_snd_pcm_lib_alloc_vmalloc_buffer);
424
425/**
426 * snd_pcm_lib_free_vmalloc_buffer - free vmalloc buffer
427 * @substream: the substream with a buffer allocated by
428 * snd_pcm_lib_alloc_vmalloc_buffer()
429 *
430 * Return: Zero if successful, or a negative error code on failure.
431 */
432int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream)
433{
434 struct snd_pcm_runtime *runtime;
435
436 if (PCM_RUNTIME_CHECK(substream))
437 return -EINVAL;
438 runtime = substream->runtime;
439 vfree(runtime->dma_area);
440 runtime->dma_area = NULL;
441 return 0;
442}
443EXPORT_SYMBOL(snd_pcm_lib_free_vmalloc_buffer);
444
445/**
446 * snd_pcm_lib_get_vmalloc_page - map vmalloc buffer offset to page struct
447 * @substream: the substream with a buffer allocated by
448 * snd_pcm_lib_alloc_vmalloc_buffer()
449 * @offset: offset in the buffer
450 *
451 * This function is to be used as the page callback in the PCM ops.
452 *
453 * Return: The page struct, or %NULL on failure.
454 */
455struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
456 unsigned long offset)
457{
458 return vmalloc_to_page(substream->runtime->dma_area + offset);
459}
460EXPORT_SYMBOL(snd_pcm_lib_get_vmalloc_page);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 */
6
7#include <linux/io.h>
8#include <linux/time.h>
9#include <linux/init.h>
10#include <linux/slab.h>
11#include <linux/moduleparam.h>
12#include <linux/vmalloc.h>
13#include <linux/export.h>
14#include <sound/core.h>
15#include <sound/pcm.h>
16#include <sound/info.h>
17#include <sound/initval.h>
18#include "pcm_local.h"
19
20static int preallocate_dma = 1;
21module_param(preallocate_dma, int, 0444);
22MODULE_PARM_DESC(preallocate_dma, "Preallocate DMA memory when the PCM devices are initialized.");
23
24static int maximum_substreams = 4;
25module_param(maximum_substreams, int, 0444);
26MODULE_PARM_DESC(maximum_substreams, "Maximum substreams with preallocated DMA memory.");
27
28static const size_t snd_minimum_buffer = 16384;
29
30static unsigned long max_alloc_per_card = 32UL * 1024UL * 1024UL;
31module_param(max_alloc_per_card, ulong, 0644);
32MODULE_PARM_DESC(max_alloc_per_card, "Max total allocation bytes per card.");
33
34static int do_alloc_pages(struct snd_card *card, int type, struct device *dev,
35 size_t size, struct snd_dma_buffer *dmab)
36{
37 int err;
38
39 if (max_alloc_per_card &&
40 card->total_pcm_alloc_bytes + size > max_alloc_per_card)
41 return -ENOMEM;
42
43 err = snd_dma_alloc_pages(type, dev, size, dmab);
44 if (!err) {
45 mutex_lock(&card->memory_mutex);
46 card->total_pcm_alloc_bytes += dmab->bytes;
47 mutex_unlock(&card->memory_mutex);
48 }
49 return err;
50}
51
52static void do_free_pages(struct snd_card *card, struct snd_dma_buffer *dmab)
53{
54 if (!dmab->area)
55 return;
56 mutex_lock(&card->memory_mutex);
57 WARN_ON(card->total_pcm_alloc_bytes < dmab->bytes);
58 card->total_pcm_alloc_bytes -= dmab->bytes;
59 mutex_unlock(&card->memory_mutex);
60 snd_dma_free_pages(dmab);
61 dmab->area = NULL;
62}
63
64/*
65 * try to allocate as the large pages as possible.
66 * stores the resultant memory size in *res_size.
67 *
68 * the minimum size is snd_minimum_buffer. it should be power of 2.
69 */
70static int preallocate_pcm_pages(struct snd_pcm_substream *substream, size_t size)
71{
72 struct snd_dma_buffer *dmab = &substream->dma_buffer;
73 struct snd_card *card = substream->pcm->card;
74 size_t orig_size = size;
75 int err;
76
77 do {
78 err = do_alloc_pages(card, dmab->dev.type, dmab->dev.dev,
79 size, dmab);
80 if (err != -ENOMEM)
81 return err;
82 size >>= 1;
83 } while (size >= snd_minimum_buffer);
84 dmab->bytes = 0; /* tell error */
85 pr_warn("ALSA pcmC%dD%d%c,%d:%s: cannot preallocate for size %zu\n",
86 substream->pcm->card->number, substream->pcm->device,
87 substream->stream ? 'c' : 'p', substream->number,
88 substream->pcm->name, orig_size);
89 return 0;
90}
91
92/*
93 * release the preallocated buffer if not yet done.
94 */
95static void snd_pcm_lib_preallocate_dma_free(struct snd_pcm_substream *substream)
96{
97 do_free_pages(substream->pcm->card, &substream->dma_buffer);
98}
99
100/**
101 * snd_pcm_lib_preallocate_free - release the preallocated buffer of the specified substream.
102 * @substream: the pcm substream instance
103 *
104 * Releases the pre-allocated buffer of the given substream.
105 */
106void snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream)
107{
108 snd_pcm_lib_preallocate_dma_free(substream);
109}
110
111/**
112 * snd_pcm_lib_preallocate_free_for_all - release all pre-allocated buffers on the pcm
113 * @pcm: the pcm instance
114 *
115 * Releases all the pre-allocated buffers on the given pcm.
116 */
117void snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm)
118{
119 struct snd_pcm_substream *substream;
120 int stream;
121
122 for (stream = 0; stream < 2; stream++)
123 for (substream = pcm->streams[stream].substream; substream; substream = substream->next)
124 snd_pcm_lib_preallocate_free(substream);
125}
126EXPORT_SYMBOL(snd_pcm_lib_preallocate_free_for_all);
127
128#ifdef CONFIG_SND_VERBOSE_PROCFS
129/*
130 * read callback for prealloc proc file
131 *
132 * prints the current allocated size in kB.
133 */
134static void snd_pcm_lib_preallocate_proc_read(struct snd_info_entry *entry,
135 struct snd_info_buffer *buffer)
136{
137 struct snd_pcm_substream *substream = entry->private_data;
138 snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_buffer.bytes / 1024);
139}
140
141/*
142 * read callback for prealloc_max proc file
143 *
144 * prints the maximum allowed size in kB.
145 */
146static void snd_pcm_lib_preallocate_max_proc_read(struct snd_info_entry *entry,
147 struct snd_info_buffer *buffer)
148{
149 struct snd_pcm_substream *substream = entry->private_data;
150 snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_max / 1024);
151}
152
153/*
154 * write callback for prealloc proc file
155 *
156 * accepts the preallocation size in kB.
157 */
158static void snd_pcm_lib_preallocate_proc_write(struct snd_info_entry *entry,
159 struct snd_info_buffer *buffer)
160{
161 struct snd_pcm_substream *substream = entry->private_data;
162 struct snd_card *card = substream->pcm->card;
163 char line[64], str[64];
164 size_t size;
165 struct snd_dma_buffer new_dmab;
166
167 if (substream->runtime) {
168 buffer->error = -EBUSY;
169 return;
170 }
171 if (!snd_info_get_line(buffer, line, sizeof(line))) {
172 snd_info_get_str(str, line, sizeof(str));
173 size = simple_strtoul(str, NULL, 10) * 1024;
174 if ((size != 0 && size < 8192) || size > substream->dma_max) {
175 buffer->error = -EINVAL;
176 return;
177 }
178 if (substream->dma_buffer.bytes == size)
179 return;
180 memset(&new_dmab, 0, sizeof(new_dmab));
181 new_dmab.dev = substream->dma_buffer.dev;
182 if (size > 0) {
183 if (do_alloc_pages(card,
184 substream->dma_buffer.dev.type,
185 substream->dma_buffer.dev.dev,
186 size, &new_dmab) < 0) {
187 buffer->error = -ENOMEM;
188 return;
189 }
190 substream->buffer_bytes_max = size;
191 } else {
192 substream->buffer_bytes_max = UINT_MAX;
193 }
194 if (substream->dma_buffer.area)
195 do_free_pages(card, &substream->dma_buffer);
196 substream->dma_buffer = new_dmab;
197 } else {
198 buffer->error = -EINVAL;
199 }
200}
201
202static inline void preallocate_info_init(struct snd_pcm_substream *substream)
203{
204 struct snd_info_entry *entry;
205
206 entry = snd_info_create_card_entry(substream->pcm->card, "prealloc",
207 substream->proc_root);
208 if (entry) {
209 snd_info_set_text_ops(entry, substream,
210 snd_pcm_lib_preallocate_proc_read);
211 entry->c.text.write = snd_pcm_lib_preallocate_proc_write;
212 entry->mode |= 0200;
213 }
214 entry = snd_info_create_card_entry(substream->pcm->card, "prealloc_max",
215 substream->proc_root);
216 if (entry)
217 snd_info_set_text_ops(entry, substream,
218 snd_pcm_lib_preallocate_max_proc_read);
219}
220
221#else /* !CONFIG_SND_VERBOSE_PROCFS */
222#define preallocate_info_init(s)
223#endif /* CONFIG_SND_VERBOSE_PROCFS */
224
225/*
226 * pre-allocate the buffer and create a proc file for the substream
227 */
228static void preallocate_pages(struct snd_pcm_substream *substream,
229 int type, struct device *data,
230 size_t size, size_t max, bool managed)
231{
232 if (snd_BUG_ON(substream->dma_buffer.dev.type))
233 return;
234
235 substream->dma_buffer.dev.type = type;
236 substream->dma_buffer.dev.dev = data;
237
238 if (size > 0 && preallocate_dma && substream->number < maximum_substreams)
239 preallocate_pcm_pages(substream, size);
240
241 if (substream->dma_buffer.bytes > 0)
242 substream->buffer_bytes_max = substream->dma_buffer.bytes;
243 substream->dma_max = max;
244 if (max > 0)
245 preallocate_info_init(substream);
246 if (managed)
247 substream->managed_buffer_alloc = 1;
248}
249
250static void preallocate_pages_for_all(struct snd_pcm *pcm, int type,
251 void *data, size_t size, size_t max,
252 bool managed)
253{
254 struct snd_pcm_substream *substream;
255 int stream;
256
257 for (stream = 0; stream < 2; stream++)
258 for (substream = pcm->streams[stream].substream; substream;
259 substream = substream->next)
260 preallocate_pages(substream, type, data, size, max,
261 managed);
262}
263
264/**
265 * snd_pcm_lib_preallocate_pages - pre-allocation for the given DMA type
266 * @substream: the pcm substream instance
267 * @type: DMA type (SNDRV_DMA_TYPE_*)
268 * @data: DMA type dependent data
269 * @size: the requested pre-allocation size in bytes
270 * @max: the max. allowed pre-allocation size
271 *
272 * Do pre-allocation for the given DMA buffer type.
273 */
274void snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
275 int type, struct device *data,
276 size_t size, size_t max)
277{
278 preallocate_pages(substream, type, data, size, max, false);
279}
280EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages);
281
282/**
283 * snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continuous memory type (all substreams)
284 * @pcm: the pcm instance
285 * @type: DMA type (SNDRV_DMA_TYPE_*)
286 * @data: DMA type dependent data
287 * @size: the requested pre-allocation size in bytes
288 * @max: the max. allowed pre-allocation size
289 *
290 * Do pre-allocation to all substreams of the given pcm for the
291 * specified DMA type.
292 */
293void snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
294 int type, void *data,
295 size_t size, size_t max)
296{
297 preallocate_pages_for_all(pcm, type, data, size, max, false);
298}
299EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages_for_all);
300
301/**
302 * snd_pcm_set_managed_buffer - set up buffer management for a substream
303 * @substream: the pcm substream instance
304 * @type: DMA type (SNDRV_DMA_TYPE_*)
305 * @data: DMA type dependent data
306 * @size: the requested pre-allocation size in bytes
307 * @max: the max. allowed pre-allocation size
308 *
309 * Do pre-allocation for the given DMA buffer type, and set the managed
310 * buffer allocation mode to the given substream.
311 * In this mode, PCM core will allocate a buffer automatically before PCM
312 * hw_params ops call, and release the buffer after PCM hw_free ops call
313 * as well, so that the driver doesn't need to invoke the allocation and
314 * the release explicitly in its callback.
315 * When a buffer is actually allocated before the PCM hw_params call, it
316 * turns on the runtime buffer_changed flag for drivers changing their h/w
317 * parameters accordingly.
318 */
319void snd_pcm_set_managed_buffer(struct snd_pcm_substream *substream, int type,
320 struct device *data, size_t size, size_t max)
321{
322 preallocate_pages(substream, type, data, size, max, true);
323}
324EXPORT_SYMBOL(snd_pcm_set_managed_buffer);
325
326/**
327 * snd_pcm_set_managed_buffer_all - set up buffer management for all substreams
328 * for all substreams
329 * @pcm: the pcm instance
330 * @type: DMA type (SNDRV_DMA_TYPE_*)
331 * @data: DMA type dependent data
332 * @size: the requested pre-allocation size in bytes
333 * @max: the max. allowed pre-allocation size
334 *
335 * Do pre-allocation to all substreams of the given pcm for the specified DMA
336 * type and size, and set the managed_buffer_alloc flag to each substream.
337 */
338void snd_pcm_set_managed_buffer_all(struct snd_pcm *pcm, int type,
339 struct device *data,
340 size_t size, size_t max)
341{
342 preallocate_pages_for_all(pcm, type, data, size, max, true);
343}
344EXPORT_SYMBOL(snd_pcm_set_managed_buffer_all);
345
346#ifdef CONFIG_SND_DMA_SGBUF
347/*
348 * snd_pcm_sgbuf_ops_page - get the page struct at the given offset
349 * @substream: the pcm substream instance
350 * @offset: the buffer offset
351 *
352 * Used as the page callback of PCM ops.
353 *
354 * Return: The page struct at the given buffer offset. %NULL on failure.
355 */
356struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset)
357{
358 struct snd_sg_buf *sgbuf = snd_pcm_substream_sgbuf(substream);
359
360 unsigned int idx = offset >> PAGE_SHIFT;
361 if (idx >= (unsigned int)sgbuf->pages)
362 return NULL;
363 return sgbuf->page_table[idx];
364}
365#endif /* CONFIG_SND_DMA_SGBUF */
366
367/**
368 * snd_pcm_lib_malloc_pages - allocate the DMA buffer
369 * @substream: the substream to allocate the DMA buffer to
370 * @size: the requested buffer size in bytes
371 *
372 * Allocates the DMA buffer on the BUS type given earlier to
373 * snd_pcm_lib_preallocate_xxx_pages().
374 *
375 * Return: 1 if the buffer is changed, 0 if not changed, or a negative
376 * code on failure.
377 */
378int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size)
379{
380 struct snd_card *card = substream->pcm->card;
381 struct snd_pcm_runtime *runtime;
382 struct snd_dma_buffer *dmab = NULL;
383
384 if (PCM_RUNTIME_CHECK(substream))
385 return -EINVAL;
386 if (snd_BUG_ON(substream->dma_buffer.dev.type ==
387 SNDRV_DMA_TYPE_UNKNOWN))
388 return -EINVAL;
389 runtime = substream->runtime;
390
391 if (runtime->dma_buffer_p) {
392 /* perphaps, we might free the large DMA memory region
393 to save some space here, but the actual solution
394 costs us less time */
395 if (runtime->dma_buffer_p->bytes >= size) {
396 runtime->dma_bytes = size;
397 return 0; /* ok, do not change */
398 }
399 snd_pcm_lib_free_pages(substream);
400 }
401 if (substream->dma_buffer.area != NULL &&
402 substream->dma_buffer.bytes >= size) {
403 dmab = &substream->dma_buffer; /* use the pre-allocated buffer */
404 } else {
405 dmab = kzalloc(sizeof(*dmab), GFP_KERNEL);
406 if (! dmab)
407 return -ENOMEM;
408 dmab->dev = substream->dma_buffer.dev;
409 if (do_alloc_pages(card,
410 substream->dma_buffer.dev.type,
411 substream->dma_buffer.dev.dev,
412 size, dmab) < 0) {
413 kfree(dmab);
414 return -ENOMEM;
415 }
416 }
417 snd_pcm_set_runtime_buffer(substream, dmab);
418 runtime->dma_bytes = size;
419 return 1; /* area was changed */
420}
421EXPORT_SYMBOL(snd_pcm_lib_malloc_pages);
422
423/**
424 * snd_pcm_lib_free_pages - release the allocated DMA buffer.
425 * @substream: the substream to release the DMA buffer
426 *
427 * Releases the DMA buffer allocated via snd_pcm_lib_malloc_pages().
428 *
429 * Return: Zero if successful, or a negative error code on failure.
430 */
431int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream)
432{
433 struct snd_card *card = substream->pcm->card;
434 struct snd_pcm_runtime *runtime;
435
436 if (PCM_RUNTIME_CHECK(substream))
437 return -EINVAL;
438 runtime = substream->runtime;
439 if (runtime->dma_area == NULL)
440 return 0;
441 if (runtime->dma_buffer_p != &substream->dma_buffer) {
442 /* it's a newly allocated buffer. release it now. */
443 do_free_pages(card, runtime->dma_buffer_p);
444 kfree(runtime->dma_buffer_p);
445 }
446 snd_pcm_set_runtime_buffer(substream, NULL);
447 return 0;
448}
449EXPORT_SYMBOL(snd_pcm_lib_free_pages);
450
451int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
452 size_t size, gfp_t gfp_flags)
453{
454 struct snd_pcm_runtime *runtime;
455
456 if (PCM_RUNTIME_CHECK(substream))
457 return -EINVAL;
458 runtime = substream->runtime;
459 if (runtime->dma_area) {
460 if (runtime->dma_bytes >= size)
461 return 0; /* already large enough */
462 vfree(runtime->dma_area);
463 }
464 runtime->dma_area = __vmalloc(size, gfp_flags);
465 if (!runtime->dma_area)
466 return -ENOMEM;
467 runtime->dma_bytes = size;
468 return 1;
469}
470EXPORT_SYMBOL(_snd_pcm_lib_alloc_vmalloc_buffer);
471
472/**
473 * snd_pcm_lib_free_vmalloc_buffer - free vmalloc buffer
474 * @substream: the substream with a buffer allocated by
475 * snd_pcm_lib_alloc_vmalloc_buffer()
476 *
477 * Return: Zero if successful, or a negative error code on failure.
478 */
479int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream)
480{
481 struct snd_pcm_runtime *runtime;
482
483 if (PCM_RUNTIME_CHECK(substream))
484 return -EINVAL;
485 runtime = substream->runtime;
486 vfree(runtime->dma_area);
487 runtime->dma_area = NULL;
488 return 0;
489}
490EXPORT_SYMBOL(snd_pcm_lib_free_vmalloc_buffer);
491
492/**
493 * snd_pcm_lib_get_vmalloc_page - map vmalloc buffer offset to page struct
494 * @substream: the substream with a buffer allocated by
495 * snd_pcm_lib_alloc_vmalloc_buffer()
496 * @offset: offset in the buffer
497 *
498 * This function is to be used as the page callback in the PCM ops.
499 *
500 * Return: The page struct, or %NULL on failure.
501 */
502struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
503 unsigned long offset)
504{
505 return vmalloc_to_page(substream->runtime->dma_area + offset);
506}
507EXPORT_SYMBOL(snd_pcm_lib_get_vmalloc_page);