2 * Copyright (c) by Jaroslav Kysela <perex@perex.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/module.h>
25 #include <linux/proc_fs.h>
26 #include <linux/init.h>
27 #include <linux/pci.h>
28 #include <linux/slab.h>
30 #include <linux/seq_file.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@perex.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
72 * Generic memory allocators
76 static long snd_allocated_pages; /* holding the number of allocated pages */
78 static inline void inc_snd_pages(int order)
80 snd_allocated_pages += 1 << order;
83 static inline void dec_snd_pages(int order)
85 snd_allocated_pages -= 1 << order;
89 * snd_malloc_pages - allocate pages with the given size
90 * @size: the size to allocate in bytes
91 * @gfp_flags: the allocation conditions, GFP_XXX
93 * Allocates the physically contiguous pages with the given size.
95 * Returns the pointer of the buffer, or NULL if no enoguh memory.
97 void *snd_malloc_pages(size_t size, gfp_t gfp_flags)
104 if (WARN_ON(!gfp_flags))
106 gfp_flags |= __GFP_COMP; /* compound page lets parts be mapped */
107 pg = get_order(size);
108 if ((res = (void *) __get_free_pages(gfp_flags, pg)) != NULL)
114 * snd_free_pages - release the pages
115 * @ptr: the buffer pointer to release
116 * @size: the allocated buffer size
118 * Releases the buffer allocated via snd_malloc_pages().
120 void snd_free_pages(void *ptr, size_t size)
126 pg = get_order(size);
128 free_pages((unsigned long) ptr, pg);
133 * Bus-specific memory allocators
137 #ifdef CONFIG_HAS_DMA
138 /* allocate the coherent DMA pages */
139 static void *snd_malloc_dev_pages(struct device *dev, size_t size, dma_addr_t *dma)
147 pg = get_order(size);
148 gfp_flags = GFP_KERNEL
149 | __GFP_COMP /* compound page lets parts be mapped */
150 | __GFP_NORETRY /* don't trigger OOM-killer */
151 | __GFP_NOWARN; /* no stack trace print - this call is non-critical */
152 res = dma_alloc_coherent(dev, PAGE_SIZE << pg, dma, gfp_flags);
159 /* free the coherent DMA pages */
160 static void snd_free_dev_pages(struct device *dev, size_t size, void *ptr,
167 pg = get_order(size);
169 dma_free_coherent(dev, PAGE_SIZE << pg, ptr, dma);
171 #endif /* CONFIG_HAS_DMA */
175 static void *snd_malloc_sbus_pages(struct device *dev, size_t size,
176 dma_addr_t *dma_addr)
178 struct sbus_dev *sdev = (struct sbus_dev *)dev;
182 if (WARN_ON(!dma_addr))
184 pg = get_order(size);
185 res = sbus_alloc_consistent(sdev, PAGE_SIZE * (1 << pg), dma_addr);
191 static void snd_free_sbus_pages(struct device *dev, size_t size,
192 void *ptr, dma_addr_t dma_addr)
194 struct sbus_dev *sdev = (struct sbus_dev *)dev;
199 pg = get_order(size);
201 sbus_free_consistent(sdev, PAGE_SIZE * (1 << pg), ptr, dma_addr);
204 #endif /* CONFIG_SBUS */
208 * ALSA generic memory management
214 * snd_dma_alloc_pages - allocate the buffer area according to the given type
215 * @type: the DMA buffer type
216 * @device: the device pointer
217 * @size: the buffer size to allocate
218 * @dmab: buffer allocation record to store the allocated data
220 * Calls the memory-allocator function for the corresponding
223 * Returns zero if the buffer with the given size is allocated successfuly,
224 * other a negative value at error.
226 int snd_dma_alloc_pages(int type, struct device *device, size_t size,
227 struct snd_dma_buffer *dmab)
234 dmab->dev.type = type;
235 dmab->dev.dev = device;
238 case SNDRV_DMA_TYPE_CONTINUOUS:
239 dmab->area = snd_malloc_pages(size, (unsigned long)device);
243 case SNDRV_DMA_TYPE_SBUS:
244 dmab->area = snd_malloc_sbus_pages(device, size, &dmab->addr);
247 #ifdef CONFIG_HAS_DMA
248 case SNDRV_DMA_TYPE_DEV:
249 dmab->area = snd_malloc_dev_pages(device, size, &dmab->addr);
251 case SNDRV_DMA_TYPE_DEV_SG:
252 snd_malloc_sgbuf_pages(device, size, dmab, NULL);
256 printk(KERN_ERR "snd-malloc: invalid device type %d\n", type);
268 * snd_dma_alloc_pages_fallback - allocate the buffer area according to the given type with fallback
269 * @type: the DMA buffer type
270 * @device: the device pointer
271 * @size: the buffer size to allocate
272 * @dmab: buffer allocation record to store the allocated data
274 * Calls the memory-allocator function for the corresponding
275 * buffer type. When no space is left, this function reduces the size and
276 * tries to allocate again. The size actually allocated is stored in
279 * Returns zero if the buffer with the given size is allocated successfuly,
280 * other a negative value at error.
282 int snd_dma_alloc_pages_fallback(int type, struct device *device, size_t size,
283 struct snd_dma_buffer *dmab)
287 while ((err = snd_dma_alloc_pages(type, device, size, dmab)) < 0) {
291 if (size <= PAGE_SIZE)
301 * snd_dma_free_pages - release the allocated buffer
302 * @dmab: the buffer allocation record to release
304 * Releases the allocated buffer via snd_dma_alloc_pages().
306 void snd_dma_free_pages(struct snd_dma_buffer *dmab)
308 switch (dmab->dev.type) {
309 case SNDRV_DMA_TYPE_CONTINUOUS:
310 snd_free_pages(dmab->area, dmab->bytes);
313 case SNDRV_DMA_TYPE_SBUS:
314 snd_free_sbus_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
317 #ifdef CONFIG_HAS_DMA
318 case SNDRV_DMA_TYPE_DEV:
319 snd_free_dev_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
321 case SNDRV_DMA_TYPE_DEV_SG:
322 snd_free_sgbuf_pages(dmab);
326 printk(KERN_ERR "snd-malloc: invalid device type %d\n", dmab->dev.type);
332 * snd_dma_get_reserved - get the reserved buffer for the given device
333 * @dmab: the buffer allocation record to store
336 * Looks for the reserved-buffer list and re-uses if the same buffer
337 * is found in the list. When the buffer is found, it's removed from the free list.
339 * Returns the size of buffer if the buffer is found, or zero if not found.
341 size_t snd_dma_get_reserved_buf(struct snd_dma_buffer *dmab, unsigned int id)
343 struct snd_mem_list *mem;
348 mutex_lock(&list_mutex);
349 list_for_each_entry(mem, &mem_list_head, list) {
351 (mem->buffer.dev.dev == NULL || dmab->dev.dev == NULL ||
352 ! memcmp(&mem->buffer.dev, &dmab->dev, sizeof(dmab->dev)))) {
353 struct device *dev = dmab->dev.dev;
354 list_del(&mem->list);
356 if (dmab->dev.dev == NULL)
359 mutex_unlock(&list_mutex);
363 mutex_unlock(&list_mutex);
368 * snd_dma_reserve_buf - reserve the buffer
369 * @dmab: the buffer to reserve
372 * Reserves the given buffer as a reserved buffer.
374 * Returns zero if successful, or a negative code at error.
376 int snd_dma_reserve_buf(struct snd_dma_buffer *dmab, unsigned int id)
378 struct snd_mem_list *mem;
382 mem = kmalloc(sizeof(*mem), GFP_KERNEL);
385 mutex_lock(&list_mutex);
388 list_add_tail(&mem->list, &mem_list_head);
389 mutex_unlock(&list_mutex);
394 * purge all reserved buffers
396 static void free_all_reserved_pages(void)
399 struct snd_mem_list *mem;
401 mutex_lock(&list_mutex);
402 while (! list_empty(&mem_list_head)) {
403 p = mem_list_head.next;
404 mem = list_entry(p, struct snd_mem_list, list);
406 snd_dma_free_pages(&mem->buffer);
409 mutex_unlock(&list_mutex);
413 #ifdef CONFIG_PROC_FS
415 * proc file interface
417 #define SND_MEM_PROC_FILE "driver/snd-page-alloc"
418 static struct proc_dir_entry *snd_mem_proc;
420 static int snd_mem_proc_read(struct seq_file *seq, void *offset)
422 long pages = snd_allocated_pages >> (PAGE_SHIFT-12);
423 struct snd_mem_list *mem;
425 static char *types[] = { "UNKNOWN", "CONT", "DEV", "DEV-SG", "SBUS" };
427 mutex_lock(&list_mutex);
428 seq_printf(seq, "pages : %li bytes (%li pages per %likB)\n",
429 pages * PAGE_SIZE, pages, PAGE_SIZE / 1024);
431 list_for_each_entry(mem, &mem_list_head, list) {
433 seq_printf(seq, "buffer %d : ID %08x : type %s\n",
434 devno, mem->id, types[mem->buffer.dev.type]);
435 seq_printf(seq, " addr = 0x%lx, size = %d bytes\n",
436 (unsigned long)mem->buffer.addr,
437 (int)mem->buffer.bytes);
439 mutex_unlock(&list_mutex);
443 static int snd_mem_proc_open(struct inode *inode, struct file *file)
445 return single_open(file, snd_mem_proc_read, NULL);
448 /* FIXME: for pci only - other bus? */
450 #define gettoken(bufp) strsep(bufp, " \t\n")
452 static ssize_t snd_mem_proc_write(struct file *file, const char __user * buffer,
453 size_t count, loff_t * ppos)
458 if (count > sizeof(buf) - 1)
460 if (copy_from_user(buf, buffer, count))
465 token = gettoken(&p);
466 if (! token || *token == '#')
468 if (strcmp(token, "add") == 0) {
470 int vendor, device, size, buffers;
475 if ((token = gettoken(&p)) == NULL ||
476 (vendor = simple_strtol(token, NULL, 0)) <= 0 ||
477 (token = gettoken(&p)) == NULL ||
478 (device = simple_strtol(token, NULL, 0)) <= 0 ||
479 (token = gettoken(&p)) == NULL ||
480 (mask = simple_strtol(token, NULL, 0)) < 0 ||
481 (token = gettoken(&p)) == NULL ||
482 (size = memparse(token, &endp)) < 64*1024 ||
483 size > 16*1024*1024 /* too big */ ||
484 (token = gettoken(&p)) == NULL ||
485 (buffers = simple_strtol(token, NULL, 0)) <= 0 ||
487 printk(KERN_ERR "snd-page-alloc: invalid proc write format\n");
495 while ((pci = pci_get_device(vendor, device, pci)) != NULL) {
496 if (mask > 0 && mask < 0xffffffff) {
497 if (pci_set_dma_mask(pci, mask) < 0 ||
498 pci_set_consistent_dma_mask(pci, mask) < 0) {
499 printk(KERN_ERR "snd-page-alloc: cannot set DMA mask %lx for pci %04x:%04x\n", mask, vendor, device);
504 for (i = 0; i < buffers; i++) {
505 struct snd_dma_buffer dmab;
506 memset(&dmab, 0, sizeof(dmab));
507 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
509 printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
513 snd_dma_reserve_buf(&dmab, snd_dma_pci_buf_id(pci));
518 for (i = 0; i < buffers; i++) {
519 struct snd_dma_buffer dmab;
520 memset(&dmab, 0, sizeof(dmab));
521 /* FIXME: We can allocate only in ZONE_DMA
522 * without a device pointer!
524 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, NULL,
526 printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
529 snd_dma_reserve_buf(&dmab, (unsigned int)((vendor << 16) | device));
532 } else if (strcmp(token, "erase") == 0)
533 /* FIXME: need for releasing each buffer chunk? */
534 free_all_reserved_pages();
536 printk(KERN_ERR "snd-page-alloc: invalid proc cmd\n");
539 #endif /* CONFIG_PCI */
541 static const struct file_operations snd_mem_proc_fops = {
542 .owner = THIS_MODULE,
543 .open = snd_mem_proc_open,
546 .write = snd_mem_proc_write,
549 .release = single_release,
552 #endif /* CONFIG_PROC_FS */
558 static int __init snd_mem_init(void)
560 #ifdef CONFIG_PROC_FS
561 snd_mem_proc = proc_create(SND_MEM_PROC_FILE, 0644, NULL,
567 static void __exit snd_mem_exit(void)
569 remove_proc_entry(SND_MEM_PROC_FILE, NULL);
570 free_all_reserved_pages();
571 if (snd_allocated_pages > 0)
572 printk(KERN_ERR "snd-malloc: Memory leak? pages not freed = %li\n", snd_allocated_pages);
576 module_init(snd_mem_init)
577 module_exit(snd_mem_exit)
583 EXPORT_SYMBOL(snd_dma_alloc_pages);
584 EXPORT_SYMBOL(snd_dma_alloc_pages_fallback);
585 EXPORT_SYMBOL(snd_dma_free_pages);
587 EXPORT_SYMBOL(snd_dma_get_reserved_buf);
588 EXPORT_SYMBOL(snd_dma_reserve_buf);
590 EXPORT_SYMBOL(snd_malloc_pages);
591 EXPORT_SYMBOL(snd_free_pages);