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 <asm/semaphore.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 DECLARE_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...) /**/
86 #if defined(__i386__) || defined(__ppc__) || defined(__x86_64__)
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
144 #if ! defined(__arm__)
145 #define NEED_RESERVE_PAGES
150 * Generic memory allocators
154 static long snd_allocated_pages; /* holding the number of allocated pages */
156 static inline void inc_snd_pages(int order)
158 snd_allocated_pages += 1 << order;
161 static inline void dec_snd_pages(int order)
163 snd_allocated_pages -= 1 << order;
166 static void mark_pages(struct page *page, int order)
168 struct page *last_page = page + (1 << order);
169 while (page < last_page)
170 SetPageReserved(page++);
173 static void unmark_pages(struct page *page, int order)
175 struct page *last_page = page + (1 << order);
176 while (page < last_page)
177 ClearPageReserved(page++);
181 * snd_malloc_pages - allocate pages with the given size
182 * @size: the size to allocate in bytes
183 * @gfp_flags: the allocation conditions, GFP_XXX
185 * Allocates the physically contiguous pages with the given size.
187 * Returns the pointer of the buffer, or NULL if no enoguh memory.
189 void *snd_malloc_pages(size_t size, gfp_t gfp_flags)
194 snd_assert(size > 0, return NULL);
195 snd_assert(gfp_flags != 0, return NULL);
196 gfp_flags |= __GFP_COMP; /* compound page lets parts be mapped */
197 pg = get_order(size);
198 if ((res = (void *) __get_free_pages(gfp_flags, pg)) != NULL) {
199 mark_pages(virt_to_page(res), pg);
206 * snd_free_pages - release the pages
207 * @ptr: the buffer pointer to release
208 * @size: the allocated buffer size
210 * Releases the buffer allocated via snd_malloc_pages().
212 void snd_free_pages(void *ptr, size_t size)
218 pg = get_order(size);
220 unmark_pages(virt_to_page(ptr), pg);
221 free_pages((unsigned long) ptr, pg);
226 * Bus-specific memory allocators
230 /* allocate the coherent DMA pages */
231 static void *snd_malloc_dev_pages(struct device *dev, size_t size, dma_addr_t *dma)
237 snd_assert(size > 0, return NULL);
238 snd_assert(dma != NULL, return NULL);
239 pg = get_order(size);
240 gfp_flags = GFP_KERNEL
241 | __GFP_COMP /* compound page lets parts be mapped */
242 | __GFP_NORETRY /* don't trigger OOM-killer */
243 | __GFP_NOWARN; /* no stack trace print - this call is non-critical */
244 res = dma_alloc_coherent(dev, PAGE_SIZE << pg, dma, gfp_flags);
246 #ifdef NEED_RESERVE_PAGES
247 mark_pages(virt_to_page(res), pg); /* should be dma_to_page() */
255 /* free the coherent DMA pages */
256 static void snd_free_dev_pages(struct device *dev, size_t size, void *ptr,
263 pg = get_order(size);
265 #ifdef NEED_RESERVE_PAGES
266 unmark_pages(virt_to_page(ptr), pg); /* should be dma_to_page() */
268 dma_free_coherent(dev, PAGE_SIZE << pg, ptr, dma);
273 static void *snd_malloc_sbus_pages(struct device *dev, size_t size,
274 dma_addr_t *dma_addr)
276 struct sbus_dev *sdev = (struct sbus_dev *)dev;
280 snd_assert(size > 0, return NULL);
281 snd_assert(dma_addr != NULL, return NULL);
282 pg = get_order(size);
283 res = sbus_alloc_consistent(sdev, PAGE_SIZE * (1 << pg), dma_addr);
289 static void snd_free_sbus_pages(struct device *dev, size_t size,
290 void *ptr, dma_addr_t dma_addr)
292 struct sbus_dev *sdev = (struct sbus_dev *)dev;
297 pg = get_order(size);
299 sbus_free_consistent(sdev, PAGE_SIZE * (1 << pg), ptr, dma_addr);
302 #endif /* CONFIG_SBUS */
306 * ALSA generic memory management
312 * snd_dma_alloc_pages - allocate the buffer area according to the given type
313 * @type: the DMA buffer type
314 * @device: the device pointer
315 * @size: the buffer size to allocate
316 * @dmab: buffer allocation record to store the allocated data
318 * Calls the memory-allocator function for the corresponding
321 * Returns zero if the buffer with the given size is allocated successfuly,
322 * other a negative value at error.
324 int snd_dma_alloc_pages(int type, struct device *device, size_t size,
325 struct snd_dma_buffer *dmab)
327 snd_assert(size > 0, return -ENXIO);
328 snd_assert(dmab != NULL, return -ENXIO);
330 dmab->dev.type = type;
331 dmab->dev.dev = device;
334 case SNDRV_DMA_TYPE_CONTINUOUS:
335 dmab->area = snd_malloc_pages(size, (unsigned long)device);
339 case SNDRV_DMA_TYPE_SBUS:
340 dmab->area = snd_malloc_sbus_pages(device, size, &dmab->addr);
343 case SNDRV_DMA_TYPE_DEV:
344 dmab->area = snd_malloc_dev_pages(device, size, &dmab->addr);
346 case SNDRV_DMA_TYPE_DEV_SG:
347 snd_malloc_sgbuf_pages(device, size, dmab, NULL);
350 printk(KERN_ERR "snd-malloc: invalid device type %d\n", type);
362 * snd_dma_alloc_pages_fallback - allocate the buffer area according to the given type with fallback
363 * @type: the DMA buffer type
364 * @device: the device pointer
365 * @size: the buffer size to allocate
366 * @dmab: buffer allocation record to store the allocated data
368 * Calls the memory-allocator function for the corresponding
369 * buffer type. When no space is left, this function reduces the size and
370 * tries to allocate again. The size actually allocated is stored in
373 * Returns zero if the buffer with the given size is allocated successfuly,
374 * other a negative value at error.
376 int snd_dma_alloc_pages_fallback(int type, struct device *device, size_t size,
377 struct snd_dma_buffer *dmab)
381 snd_assert(size > 0, return -ENXIO);
382 snd_assert(dmab != NULL, return -ENXIO);
384 while ((err = snd_dma_alloc_pages(type, device, size, dmab)) < 0) {
388 if (size <= PAGE_SIZE)
398 * snd_dma_free_pages - release the allocated buffer
399 * @dmab: the buffer allocation record to release
401 * Releases the allocated buffer via snd_dma_alloc_pages().
403 void snd_dma_free_pages(struct snd_dma_buffer *dmab)
405 switch (dmab->dev.type) {
406 case SNDRV_DMA_TYPE_CONTINUOUS:
407 snd_free_pages(dmab->area, dmab->bytes);
410 case SNDRV_DMA_TYPE_SBUS:
411 snd_free_sbus_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
414 case SNDRV_DMA_TYPE_DEV:
415 snd_free_dev_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
417 case SNDRV_DMA_TYPE_DEV_SG:
418 snd_free_sgbuf_pages(dmab);
421 printk(KERN_ERR "snd-malloc: invalid device type %d\n", dmab->dev.type);
427 * snd_dma_get_reserved - get the reserved buffer for the given device
428 * @dmab: the buffer allocation record to store
431 * Looks for the reserved-buffer list and re-uses if the same buffer
432 * is found in the list. When the buffer is found, it's removed from the free list.
434 * Returns the size of buffer if the buffer is found, or zero if not found.
436 size_t snd_dma_get_reserved_buf(struct snd_dma_buffer *dmab, unsigned int id)
439 struct snd_mem_list *mem;
441 snd_assert(dmab, return 0);
444 list_for_each(p, &mem_list_head) {
445 mem = list_entry(p, struct snd_mem_list, list);
447 (mem->buffer.dev.dev == NULL || dmab->dev.dev == NULL ||
448 ! memcmp(&mem->buffer.dev, &dmab->dev, sizeof(dmab->dev)))) {
449 struct device *dev = dmab->dev.dev;
452 if (dmab->dev.dev == NULL)
464 * snd_dma_reserve_buf - reserve the buffer
465 * @dmab: the buffer to reserve
468 * Reserves the given buffer as a reserved buffer.
470 * Returns zero if successful, or a negative code at error.
472 int snd_dma_reserve_buf(struct snd_dma_buffer *dmab, unsigned int id)
474 struct snd_mem_list *mem;
476 snd_assert(dmab, return -EINVAL);
477 mem = kmalloc(sizeof(*mem), GFP_KERNEL);
483 list_add_tail(&mem->list, &mem_list_head);
489 * purge all reserved buffers
491 static void free_all_reserved_pages(void)
494 struct snd_mem_list *mem;
497 while (! list_empty(&mem_list_head)) {
498 p = mem_list_head.next;
499 mem = list_entry(p, struct snd_mem_list, list);
501 snd_dma_free_pages(&mem->buffer);
508 #ifdef CONFIG_PROC_FS
510 * proc file interface
512 #define SND_MEM_PROC_FILE "driver/snd-page-alloc"
513 static struct proc_dir_entry *snd_mem_proc;
515 static int snd_mem_proc_read(char *page, char **start, off_t off,
516 int count, int *eof, void *data)
519 long pages = snd_allocated_pages >> (PAGE_SHIFT-12);
521 struct snd_mem_list *mem;
523 static char *types[] = { "UNKNOWN", "CONT", "DEV", "DEV-SG", "SBUS" };
526 len += snprintf(page + len, count - len,
527 "pages : %li bytes (%li pages per %likB)\n",
528 pages * PAGE_SIZE, pages, PAGE_SIZE / 1024);
530 list_for_each(p, &mem_list_head) {
531 mem = list_entry(p, struct snd_mem_list, list);
533 len += snprintf(page + len, count - len,
534 "buffer %d : ID %08x : type %s\n",
535 devno, mem->id, types[mem->buffer.dev.type]);
536 len += snprintf(page + len, count - len,
537 " addr = 0x%lx, size = %d bytes\n",
538 (unsigned long)mem->buffer.addr, (int)mem->buffer.bytes);
544 /* FIXME: for pci only - other bus? */
546 #define gettoken(bufp) strsep(bufp, " \t\n")
548 static int snd_mem_proc_write(struct file *file, const char __user *buffer,
549 unsigned long count, void *data)
554 if (count > ARRAY_SIZE(buf) - 1)
555 count = ARRAY_SIZE(buf) - 1;
556 if (copy_from_user(buf, buffer, count))
558 buf[ARRAY_SIZE(buf) - 1] = '\0';
561 token = gettoken(&p);
562 if (! token || *token == '#')
564 if (strcmp(token, "add") == 0) {
566 int vendor, device, size, buffers;
571 if ((token = gettoken(&p)) == NULL ||
572 (vendor = simple_strtol(token, NULL, 0)) <= 0 ||
573 (token = gettoken(&p)) == NULL ||
574 (device = simple_strtol(token, NULL, 0)) <= 0 ||
575 (token = gettoken(&p)) == NULL ||
576 (mask = simple_strtol(token, NULL, 0)) < 0 ||
577 (token = gettoken(&p)) == NULL ||
578 (size = memparse(token, &endp)) < 64*1024 ||
579 size > 16*1024*1024 /* too big */ ||
580 (token = gettoken(&p)) == NULL ||
581 (buffers = simple_strtol(token, NULL, 0)) <= 0 ||
583 printk(KERN_ERR "snd-page-alloc: invalid proc write format\n");
591 while ((pci = pci_get_device(vendor, device, pci)) != NULL) {
592 if (mask > 0 && mask < 0xffffffff) {
593 if (pci_set_dma_mask(pci, mask) < 0 ||
594 pci_set_consistent_dma_mask(pci, mask) < 0) {
595 printk(KERN_ERR "snd-page-alloc: cannot set DMA mask %lx for pci %04x:%04x\n", mask, vendor, device);
599 for (i = 0; i < buffers; i++) {
600 struct snd_dma_buffer dmab;
601 memset(&dmab, 0, sizeof(dmab));
602 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
604 printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
608 snd_dma_reserve_buf(&dmab, snd_dma_pci_buf_id(pci));
613 for (i = 0; i < buffers; i++) {
614 struct snd_dma_buffer dmab;
615 memset(&dmab, 0, sizeof(dmab));
616 /* FIXME: We can allocate only in ZONE_DMA
617 * without a device pointer!
619 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, NULL,
621 printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
624 snd_dma_reserve_buf(&dmab, (unsigned int)((vendor << 16) | device));
627 } else if (strcmp(token, "erase") == 0)
628 /* FIXME: need for releasing each buffer chunk? */
629 free_all_reserved_pages();
631 printk(KERN_ERR "snd-page-alloc: invalid proc cmd\n");
634 #endif /* CONFIG_PCI */
635 #endif /* CONFIG_PROC_FS */
641 static int __init snd_mem_init(void)
643 #ifdef CONFIG_PROC_FS
644 snd_mem_proc = create_proc_entry(SND_MEM_PROC_FILE, 0644, NULL);
646 snd_mem_proc->read_proc = snd_mem_proc_read;
648 snd_mem_proc->write_proc = snd_mem_proc_write;
655 static void __exit snd_mem_exit(void)
657 remove_proc_entry(SND_MEM_PROC_FILE, NULL);
658 free_all_reserved_pages();
659 if (snd_allocated_pages > 0)
660 printk(KERN_ERR "snd-malloc: Memory leak? pages not freed = %li\n", snd_allocated_pages);
664 module_init(snd_mem_init)
665 module_exit(snd_mem_exit)
671 EXPORT_SYMBOL(snd_dma_alloc_pages);
672 EXPORT_SYMBOL(snd_dma_alloc_pages_fallback);
673 EXPORT_SYMBOL(snd_dma_free_pages);
675 EXPORT_SYMBOL(snd_dma_get_reserved_buf);
676 EXPORT_SYMBOL(snd_dma_reserve_buf);
678 EXPORT_SYMBOL(snd_malloc_pages);
679 EXPORT_SYMBOL(snd_free_pages);