2 * Copyright (c) by Jaroslav Kysela <perex@suse.cz>
3 * Takashi Iwai <tiwai@suse.de>
5 * Generic memory allocators
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/config.h>
25 #include <linux/module.h>
26 #include <linux/proc_fs.h>
27 #include <linux/init.h>
28 #include <linux/pci.h>
29 #include <linux/slab.h>
31 #include <asm/uaccess.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/moduleparam.h>
34 #include <linux/mutex.h>
35 #include <sound/memalloc.h>
41 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>, Jaroslav Kysela <perex@suse.cz>");
42 MODULE_DESCRIPTION("Memory allocator for ALSA system.");
43 MODULE_LICENSE("GPL");
49 void *snd_malloc_sgbuf_pages(struct device *device,
50 size_t size, struct snd_dma_buffer *dmab,
52 int snd_free_sgbuf_pages(struct snd_dma_buffer *dmab);
57 static DEFINE_MUTEX(list_mutex);
58 static LIST_HEAD(mem_list_head);
60 /* buffer preservation list */
62 struct snd_dma_buffer buffer;
64 struct list_head list;
67 /* id for pre-allocated buffers */
68 #define SNDRV_DMA_DEVICE_UNUSED (unsigned int)-1
70 #ifdef CONFIG_SND_DEBUG
71 #define __ASTRING__(x) #x
72 #define snd_assert(expr, args...) do {\
74 printk(KERN_ERR "snd-malloc: BUG? (%s) (called from %p)\n", __ASTRING__(expr), __builtin_return_address(0));\
79 #define snd_assert(expr, args...) /**/
88 * A hack to allocate large buffers via dma_alloc_coherent()
90 * since dma_alloc_coherent always tries GFP_DMA when the requested
91 * pci memory region is below 32bit, it happens quite often that even
92 * 2 order of pages cannot be allocated.
94 * so in the following, we allocate at first without dma_mask, so that
95 * allocation will be done without GFP_DMA. if the area doesn't match
96 * with the requested region, then realloate with the original dma_mask
99 * Really, we want to move this type of thing into dma_alloc_coherent()
100 * so dma_mask doesn't have to be messed with.
103 static void *snd_dma_hack_alloc_coherent(struct device *dev, size_t size,
104 dma_addr_t *dma_handle,
108 u64 dma_mask, coherent_dma_mask;
110 if (dev == NULL || !dev->dma_mask)
111 return dma_alloc_coherent(dev, size, dma_handle, flags);
112 dma_mask = *dev->dma_mask;
113 coherent_dma_mask = dev->coherent_dma_mask;
114 *dev->dma_mask = 0xffffffff; /* do without masking */
115 dev->coherent_dma_mask = 0xffffffff; /* do without masking */
116 ret = dma_alloc_coherent(dev, size, dma_handle, flags);
117 *dev->dma_mask = dma_mask; /* restore */
118 dev->coherent_dma_mask = coherent_dma_mask; /* restore */
120 /* obtained address is out of range? */
121 if (((unsigned long)*dma_handle + size - 1) & ~dma_mask) {
122 /* reallocate with the proper mask */
123 dma_free_coherent(dev, size, ret, *dma_handle);
124 ret = dma_alloc_coherent(dev, size, dma_handle, flags);
127 /* wish to success now with the proper mask... */
128 if (dma_mask != 0xffffffffUL) {
129 /* allocation with GFP_ATOMIC to avoid the long stall */
130 flags &= ~GFP_KERNEL;
132 ret = dma_alloc_coherent(dev, size, dma_handle, flags);
138 /* redefine dma_alloc_coherent for some architectures */
139 #undef dma_alloc_coherent
140 #define dma_alloc_coherent snd_dma_hack_alloc_coherent
146 * Generic memory allocators
150 static long snd_allocated_pages; /* holding the number of allocated pages */
152 static inline void inc_snd_pages(int order)
154 snd_allocated_pages += 1 << order;
157 static inline void dec_snd_pages(int order)
159 snd_allocated_pages -= 1 << order;
163 * snd_malloc_pages - allocate pages with the given size
164 * @size: the size to allocate in bytes
165 * @gfp_flags: the allocation conditions, GFP_XXX
167 * Allocates the physically contiguous pages with the given size.
169 * Returns the pointer of the buffer, or NULL if no enoguh memory.
171 void *snd_malloc_pages(size_t size, gfp_t gfp_flags)
176 snd_assert(size > 0, return NULL);
177 snd_assert(gfp_flags != 0, return NULL);
178 gfp_flags |= __GFP_COMP; /* compound page lets parts be mapped */
179 pg = get_order(size);
180 if ((res = (void *) __get_free_pages(gfp_flags, pg)) != NULL)
186 * snd_free_pages - release the pages
187 * @ptr: the buffer pointer to release
188 * @size: the allocated buffer size
190 * Releases the buffer allocated via snd_malloc_pages().
192 void snd_free_pages(void *ptr, size_t size)
198 pg = get_order(size);
200 free_pages((unsigned long) ptr, pg);
205 * Bus-specific memory allocators
209 /* allocate the coherent DMA pages */
210 static void *snd_malloc_dev_pages(struct device *dev, size_t size, dma_addr_t *dma)
216 snd_assert(size > 0, return NULL);
217 snd_assert(dma != NULL, return NULL);
218 pg = get_order(size);
219 gfp_flags = GFP_KERNEL
220 | __GFP_COMP /* compound page lets parts be mapped */
221 | __GFP_NORETRY /* don't trigger OOM-killer */
222 | __GFP_NOWARN; /* no stack trace print - this call is non-critical */
223 res = dma_alloc_coherent(dev, PAGE_SIZE << pg, dma, gfp_flags);
230 /* free the coherent DMA pages */
231 static void snd_free_dev_pages(struct device *dev, size_t size, void *ptr,
238 pg = get_order(size);
240 dma_free_coherent(dev, PAGE_SIZE << pg, ptr, dma);
245 static void *snd_malloc_sbus_pages(struct device *dev, size_t size,
246 dma_addr_t *dma_addr)
248 struct sbus_dev *sdev = (struct sbus_dev *)dev;
252 snd_assert(size > 0, return NULL);
253 snd_assert(dma_addr != NULL, return NULL);
254 pg = get_order(size);
255 res = sbus_alloc_consistent(sdev, PAGE_SIZE * (1 << pg), dma_addr);
261 static void snd_free_sbus_pages(struct device *dev, size_t size,
262 void *ptr, dma_addr_t dma_addr)
264 struct sbus_dev *sdev = (struct sbus_dev *)dev;
269 pg = get_order(size);
271 sbus_free_consistent(sdev, PAGE_SIZE * (1 << pg), ptr, dma_addr);
274 #endif /* CONFIG_SBUS */
278 * ALSA generic memory management
284 * snd_dma_alloc_pages - allocate the buffer area according to the given type
285 * @type: the DMA buffer type
286 * @device: the device pointer
287 * @size: the buffer size to allocate
288 * @dmab: buffer allocation record to store the allocated data
290 * Calls the memory-allocator function for the corresponding
293 * Returns zero if the buffer with the given size is allocated successfuly,
294 * other a negative value at error.
296 int snd_dma_alloc_pages(int type, struct device *device, size_t size,
297 struct snd_dma_buffer *dmab)
299 snd_assert(size > 0, return -ENXIO);
300 snd_assert(dmab != NULL, return -ENXIO);
302 dmab->dev.type = type;
303 dmab->dev.dev = device;
306 case SNDRV_DMA_TYPE_CONTINUOUS:
307 dmab->area = snd_malloc_pages(size, (unsigned long)device);
311 case SNDRV_DMA_TYPE_SBUS:
312 dmab->area = snd_malloc_sbus_pages(device, size, &dmab->addr);
315 case SNDRV_DMA_TYPE_DEV:
316 dmab->area = snd_malloc_dev_pages(device, size, &dmab->addr);
318 case SNDRV_DMA_TYPE_DEV_SG:
319 snd_malloc_sgbuf_pages(device, size, dmab, NULL);
322 printk(KERN_ERR "snd-malloc: invalid device type %d\n", type);
334 * snd_dma_alloc_pages_fallback - allocate the buffer area according to the given type with fallback
335 * @type: the DMA buffer type
336 * @device: the device pointer
337 * @size: the buffer size to allocate
338 * @dmab: buffer allocation record to store the allocated data
340 * Calls the memory-allocator function for the corresponding
341 * buffer type. When no space is left, this function reduces the size and
342 * tries to allocate again. The size actually allocated is stored in
345 * Returns zero if the buffer with the given size is allocated successfuly,
346 * other a negative value at error.
348 int snd_dma_alloc_pages_fallback(int type, struct device *device, size_t size,
349 struct snd_dma_buffer *dmab)
353 snd_assert(size > 0, return -ENXIO);
354 snd_assert(dmab != NULL, return -ENXIO);
356 while ((err = snd_dma_alloc_pages(type, device, size, dmab)) < 0) {
360 if (size <= PAGE_SIZE)
370 * snd_dma_free_pages - release the allocated buffer
371 * @dmab: the buffer allocation record to release
373 * Releases the allocated buffer via snd_dma_alloc_pages().
375 void snd_dma_free_pages(struct snd_dma_buffer *dmab)
377 switch (dmab->dev.type) {
378 case SNDRV_DMA_TYPE_CONTINUOUS:
379 snd_free_pages(dmab->area, dmab->bytes);
382 case SNDRV_DMA_TYPE_SBUS:
383 snd_free_sbus_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
386 case SNDRV_DMA_TYPE_DEV:
387 snd_free_dev_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
389 case SNDRV_DMA_TYPE_DEV_SG:
390 snd_free_sgbuf_pages(dmab);
393 printk(KERN_ERR "snd-malloc: invalid device type %d\n", dmab->dev.type);
399 * snd_dma_get_reserved - get the reserved buffer for the given device
400 * @dmab: the buffer allocation record to store
403 * Looks for the reserved-buffer list and re-uses if the same buffer
404 * is found in the list. When the buffer is found, it's removed from the free list.
406 * Returns the size of buffer if the buffer is found, or zero if not found.
408 size_t snd_dma_get_reserved_buf(struct snd_dma_buffer *dmab, unsigned int id)
411 struct snd_mem_list *mem;
413 snd_assert(dmab, return 0);
415 mutex_lock(&list_mutex);
416 list_for_each(p, &mem_list_head) {
417 mem = list_entry(p, struct snd_mem_list, list);
419 (mem->buffer.dev.dev == NULL || dmab->dev.dev == NULL ||
420 ! memcmp(&mem->buffer.dev, &dmab->dev, sizeof(dmab->dev)))) {
421 struct device *dev = dmab->dev.dev;
424 if (dmab->dev.dev == NULL)
427 mutex_unlock(&list_mutex);
431 mutex_unlock(&list_mutex);
436 * snd_dma_reserve_buf - reserve the buffer
437 * @dmab: the buffer to reserve
440 * Reserves the given buffer as a reserved buffer.
442 * Returns zero if successful, or a negative code at error.
444 int snd_dma_reserve_buf(struct snd_dma_buffer *dmab, unsigned int id)
446 struct snd_mem_list *mem;
448 snd_assert(dmab, return -EINVAL);
449 mem = kmalloc(sizeof(*mem), GFP_KERNEL);
452 mutex_lock(&list_mutex);
455 list_add_tail(&mem->list, &mem_list_head);
456 mutex_unlock(&list_mutex);
461 * purge all reserved buffers
463 static void free_all_reserved_pages(void)
466 struct snd_mem_list *mem;
468 mutex_lock(&list_mutex);
469 while (! list_empty(&mem_list_head)) {
470 p = mem_list_head.next;
471 mem = list_entry(p, struct snd_mem_list, list);
473 snd_dma_free_pages(&mem->buffer);
476 mutex_unlock(&list_mutex);
480 #ifdef CONFIG_PROC_FS
482 * proc file interface
484 #define SND_MEM_PROC_FILE "driver/snd-page-alloc"
485 static struct proc_dir_entry *snd_mem_proc;
487 static int snd_mem_proc_read(char *page, char **start, off_t off,
488 int count, int *eof, void *data)
491 long pages = snd_allocated_pages >> (PAGE_SHIFT-12);
493 struct snd_mem_list *mem;
495 static char *types[] = { "UNKNOWN", "CONT", "DEV", "DEV-SG", "SBUS" };
497 mutex_lock(&list_mutex);
498 len += snprintf(page + len, count - len,
499 "pages : %li bytes (%li pages per %likB)\n",
500 pages * PAGE_SIZE, pages, PAGE_SIZE / 1024);
502 list_for_each(p, &mem_list_head) {
503 mem = list_entry(p, struct snd_mem_list, list);
505 len += snprintf(page + len, count - len,
506 "buffer %d : ID %08x : type %s\n",
507 devno, mem->id, types[mem->buffer.dev.type]);
508 len += snprintf(page + len, count - len,
509 " addr = 0x%lx, size = %d bytes\n",
510 (unsigned long)mem->buffer.addr, (int)mem->buffer.bytes);
512 mutex_unlock(&list_mutex);
516 /* FIXME: for pci only - other bus? */
518 #define gettoken(bufp) strsep(bufp, " \t\n")
520 static int snd_mem_proc_write(struct file *file, const char __user *buffer,
521 unsigned long count, void *data)
526 if (count > ARRAY_SIZE(buf) - 1)
527 count = ARRAY_SIZE(buf) - 1;
528 if (copy_from_user(buf, buffer, count))
530 buf[ARRAY_SIZE(buf) - 1] = '\0';
533 token = gettoken(&p);
534 if (! token || *token == '#')
536 if (strcmp(token, "add") == 0) {
538 int vendor, device, size, buffers;
543 if ((token = gettoken(&p)) == NULL ||
544 (vendor = simple_strtol(token, NULL, 0)) <= 0 ||
545 (token = gettoken(&p)) == NULL ||
546 (device = simple_strtol(token, NULL, 0)) <= 0 ||
547 (token = gettoken(&p)) == NULL ||
548 (mask = simple_strtol(token, NULL, 0)) < 0 ||
549 (token = gettoken(&p)) == NULL ||
550 (size = memparse(token, &endp)) < 64*1024 ||
551 size > 16*1024*1024 /* too big */ ||
552 (token = gettoken(&p)) == NULL ||
553 (buffers = simple_strtol(token, NULL, 0)) <= 0 ||
555 printk(KERN_ERR "snd-page-alloc: invalid proc write format\n");
563 while ((pci = pci_get_device(vendor, device, pci)) != NULL) {
564 if (mask > 0 && mask < 0xffffffff) {
565 if (pci_set_dma_mask(pci, mask) < 0 ||
566 pci_set_consistent_dma_mask(pci, mask) < 0) {
567 printk(KERN_ERR "snd-page-alloc: cannot set DMA mask %lx for pci %04x:%04x\n", mask, vendor, device);
571 for (i = 0; i < buffers; i++) {
572 struct snd_dma_buffer dmab;
573 memset(&dmab, 0, sizeof(dmab));
574 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
576 printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
580 snd_dma_reserve_buf(&dmab, snd_dma_pci_buf_id(pci));
585 for (i = 0; i < buffers; i++) {
586 struct snd_dma_buffer dmab;
587 memset(&dmab, 0, sizeof(dmab));
588 /* FIXME: We can allocate only in ZONE_DMA
589 * without a device pointer!
591 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, NULL,
593 printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
596 snd_dma_reserve_buf(&dmab, (unsigned int)((vendor << 16) | device));
599 } else if (strcmp(token, "erase") == 0)
600 /* FIXME: need for releasing each buffer chunk? */
601 free_all_reserved_pages();
603 printk(KERN_ERR "snd-page-alloc: invalid proc cmd\n");
606 #endif /* CONFIG_PCI */
607 #endif /* CONFIG_PROC_FS */
613 static int __init snd_mem_init(void)
615 #ifdef CONFIG_PROC_FS
616 snd_mem_proc = create_proc_entry(SND_MEM_PROC_FILE, 0644, NULL);
618 snd_mem_proc->read_proc = snd_mem_proc_read;
620 snd_mem_proc->write_proc = snd_mem_proc_write;
627 static void __exit snd_mem_exit(void)
629 remove_proc_entry(SND_MEM_PROC_FILE, NULL);
630 free_all_reserved_pages();
631 if (snd_allocated_pages > 0)
632 printk(KERN_ERR "snd-malloc: Memory leak? pages not freed = %li\n", snd_allocated_pages);
636 module_init(snd_mem_init)
637 module_exit(snd_mem_exit)
643 EXPORT_SYMBOL(snd_dma_alloc_pages);
644 EXPORT_SYMBOL(snd_dma_alloc_pages_fallback);
645 EXPORT_SYMBOL(snd_dma_free_pages);
647 EXPORT_SYMBOL(snd_dma_get_reserved_buf);
648 EXPORT_SYMBOL(snd_dma_reserve_buf);
650 EXPORT_SYMBOL(snd_malloc_pages);
651 EXPORT_SYMBOL(snd_free_pages);