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