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
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 #ifdef CONFIG_HAS_DMA
210 /* allocate the coherent DMA pages */
211 static void *snd_malloc_dev_pages(struct device
*dev
, size_t size
, dma_addr_t
*dma
)
217 snd_assert(size
> 0, return NULL
);
218 snd_assert(dma
!= NULL
, return NULL
);
219 pg
= get_order(size
);
220 gfp_flags
= GFP_KERNEL
221 | __GFP_COMP
/* compound page lets parts be mapped */
222 | __GFP_NORETRY
/* don't trigger OOM-killer */
223 | __GFP_NOWARN
; /* no stack trace print - this call is non-critical */
224 res
= dma_alloc_coherent(dev
, PAGE_SIZE
<< pg
, dma
, gfp_flags
);
231 /* free the coherent DMA pages */
232 static void snd_free_dev_pages(struct device
*dev
, size_t size
, void *ptr
,
239 pg
= get_order(size
);
241 dma_free_coherent(dev
, PAGE_SIZE
<< pg
, ptr
, dma
);
243 #endif /* CONFIG_HAS_DMA */
247 static void *snd_malloc_sbus_pages(struct device
*dev
, size_t size
,
248 dma_addr_t
*dma_addr
)
250 struct sbus_dev
*sdev
= (struct sbus_dev
*)dev
;
254 snd_assert(size
> 0, return NULL
);
255 snd_assert(dma_addr
!= NULL
, return NULL
);
256 pg
= get_order(size
);
257 res
= sbus_alloc_consistent(sdev
, PAGE_SIZE
* (1 << pg
), dma_addr
);
263 static void snd_free_sbus_pages(struct device
*dev
, size_t size
,
264 void *ptr
, dma_addr_t dma_addr
)
266 struct sbus_dev
*sdev
= (struct sbus_dev
*)dev
;
271 pg
= get_order(size
);
273 sbus_free_consistent(sdev
, PAGE_SIZE
* (1 << pg
), ptr
, dma_addr
);
276 #endif /* CONFIG_SBUS */
280 * ALSA generic memory management
286 * snd_dma_alloc_pages - allocate the buffer area according to the given type
287 * @type: the DMA buffer type
288 * @device: the device pointer
289 * @size: the buffer size to allocate
290 * @dmab: buffer allocation record to store the allocated data
292 * Calls the memory-allocator function for the corresponding
295 * Returns zero if the buffer with the given size is allocated successfuly,
296 * other a negative value at error.
298 int snd_dma_alloc_pages(int type
, struct device
*device
, size_t size
,
299 struct snd_dma_buffer
*dmab
)
301 snd_assert(size
> 0, return -ENXIO
);
302 snd_assert(dmab
!= NULL
, return -ENXIO
);
304 dmab
->dev
.type
= type
;
305 dmab
->dev
.dev
= device
;
308 case SNDRV_DMA_TYPE_CONTINUOUS
:
309 dmab
->area
= snd_malloc_pages(size
, (unsigned long)device
);
313 case SNDRV_DMA_TYPE_SBUS
:
314 dmab
->area
= snd_malloc_sbus_pages(device
, size
, &dmab
->addr
);
317 #ifdef CONFIG_HAS_DMA
318 case SNDRV_DMA_TYPE_DEV
:
319 dmab
->area
= snd_malloc_dev_pages(device
, size
, &dmab
->addr
);
321 case SNDRV_DMA_TYPE_DEV_SG
:
322 snd_malloc_sgbuf_pages(device
, size
, dmab
, NULL
);
326 printk(KERN_ERR
"snd-malloc: invalid device type %d\n", type
);
338 * snd_dma_alloc_pages_fallback - allocate the buffer area according to the given type with fallback
339 * @type: the DMA buffer type
340 * @device: the device pointer
341 * @size: the buffer size to allocate
342 * @dmab: buffer allocation record to store the allocated data
344 * Calls the memory-allocator function for the corresponding
345 * buffer type. When no space is left, this function reduces the size and
346 * tries to allocate again. The size actually allocated is stored in
349 * Returns zero if the buffer with the given size is allocated successfuly,
350 * other a negative value at error.
352 int snd_dma_alloc_pages_fallback(int type
, struct device
*device
, size_t size
,
353 struct snd_dma_buffer
*dmab
)
357 snd_assert(size
> 0, return -ENXIO
);
358 snd_assert(dmab
!= NULL
, return -ENXIO
);
360 while ((err
= snd_dma_alloc_pages(type
, device
, size
, dmab
)) < 0) {
364 if (size
<= PAGE_SIZE
)
374 * snd_dma_free_pages - release the allocated buffer
375 * @dmab: the buffer allocation record to release
377 * Releases the allocated buffer via snd_dma_alloc_pages().
379 void snd_dma_free_pages(struct snd_dma_buffer
*dmab
)
381 switch (dmab
->dev
.type
) {
382 case SNDRV_DMA_TYPE_CONTINUOUS
:
383 snd_free_pages(dmab
->area
, dmab
->bytes
);
386 case SNDRV_DMA_TYPE_SBUS
:
387 snd_free_sbus_pages(dmab
->dev
.dev
, dmab
->bytes
, dmab
->area
, dmab
->addr
);
390 #ifdef CONFIG_HAS_DMA
391 case SNDRV_DMA_TYPE_DEV
:
392 snd_free_dev_pages(dmab
->dev
.dev
, dmab
->bytes
, dmab
->area
, dmab
->addr
);
394 case SNDRV_DMA_TYPE_DEV_SG
:
395 snd_free_sgbuf_pages(dmab
);
399 printk(KERN_ERR
"snd-malloc: invalid device type %d\n", dmab
->dev
.type
);
405 * snd_dma_get_reserved - get the reserved buffer for the given device
406 * @dmab: the buffer allocation record to store
409 * Looks for the reserved-buffer list and re-uses if the same buffer
410 * is found in the list. When the buffer is found, it's removed from the free list.
412 * Returns the size of buffer if the buffer is found, or zero if not found.
414 size_t snd_dma_get_reserved_buf(struct snd_dma_buffer
*dmab
, unsigned int id
)
416 struct snd_mem_list
*mem
;
418 snd_assert(dmab
, return 0);
420 mutex_lock(&list_mutex
);
421 list_for_each_entry(mem
, &mem_list_head
, list
) {
423 (mem
->buffer
.dev
.dev
== NULL
|| dmab
->dev
.dev
== NULL
||
424 ! memcmp(&mem
->buffer
.dev
, &dmab
->dev
, sizeof(dmab
->dev
)))) {
425 struct device
*dev
= dmab
->dev
.dev
;
426 list_del(&mem
->list
);
428 if (dmab
->dev
.dev
== NULL
)
431 mutex_unlock(&list_mutex
);
435 mutex_unlock(&list_mutex
);
440 * snd_dma_reserve_buf - reserve the buffer
441 * @dmab: the buffer to reserve
444 * Reserves the given buffer as a reserved buffer.
446 * Returns zero if successful, or a negative code at error.
448 int snd_dma_reserve_buf(struct snd_dma_buffer
*dmab
, unsigned int id
)
450 struct snd_mem_list
*mem
;
452 snd_assert(dmab
, return -EINVAL
);
453 mem
= kmalloc(sizeof(*mem
), GFP_KERNEL
);
456 mutex_lock(&list_mutex
);
459 list_add_tail(&mem
->list
, &mem_list_head
);
460 mutex_unlock(&list_mutex
);
465 * purge all reserved buffers
467 static void free_all_reserved_pages(void)
470 struct snd_mem_list
*mem
;
472 mutex_lock(&list_mutex
);
473 while (! list_empty(&mem_list_head
)) {
474 p
= mem_list_head
.next
;
475 mem
= list_entry(p
, struct snd_mem_list
, list
);
477 snd_dma_free_pages(&mem
->buffer
);
480 mutex_unlock(&list_mutex
);
484 #ifdef CONFIG_PROC_FS
486 * proc file interface
488 #define SND_MEM_PROC_FILE "driver/snd-page-alloc"
489 static struct proc_dir_entry
*snd_mem_proc
;
491 static int snd_mem_proc_read(struct seq_file
*seq
, void *offset
)
493 long pages
= snd_allocated_pages
>> (PAGE_SHIFT
-12);
494 struct snd_mem_list
*mem
;
496 static char *types
[] = { "UNKNOWN", "CONT", "DEV", "DEV-SG", "SBUS" };
498 mutex_lock(&list_mutex
);
499 seq_printf(seq
, "pages : %li bytes (%li pages per %likB)\n",
500 pages
* PAGE_SIZE
, pages
, PAGE_SIZE
/ 1024);
502 list_for_each_entry(mem
, &mem_list_head
, list
) {
504 seq_printf(seq
, "buffer %d : ID %08x : type %s\n",
505 devno
, mem
->id
, types
[mem
->buffer
.dev
.type
]);
506 seq_printf(seq
, " addr = 0x%lx, size = %d bytes\n",
507 (unsigned long)mem
->buffer
.addr
,
508 (int)mem
->buffer
.bytes
);
510 mutex_unlock(&list_mutex
);
514 static int snd_mem_proc_open(struct inode
*inode
, struct file
*file
)
516 return single_open(file
, snd_mem_proc_read
, NULL
);
519 /* FIXME: for pci only - other bus? */
521 #define gettoken(bufp) strsep(bufp, " \t\n")
523 static ssize_t
snd_mem_proc_write(struct file
*file
, const char __user
* buffer
,
524 size_t count
, loff_t
* ppos
)
529 if (count
> sizeof(buf
) - 1)
531 if (copy_from_user(buf
, buffer
, count
))
536 token
= gettoken(&p
);
537 if (! token
|| *token
== '#')
539 if (strcmp(token
, "add") == 0) {
541 int vendor
, device
, size
, buffers
;
546 if ((token
= gettoken(&p
)) == NULL
||
547 (vendor
= simple_strtol(token
, NULL
, 0)) <= 0 ||
548 (token
= gettoken(&p
)) == NULL
||
549 (device
= simple_strtol(token
, NULL
, 0)) <= 0 ||
550 (token
= gettoken(&p
)) == NULL
||
551 (mask
= simple_strtol(token
, NULL
, 0)) < 0 ||
552 (token
= gettoken(&p
)) == NULL
||
553 (size
= memparse(token
, &endp
)) < 64*1024 ||
554 size
> 16*1024*1024 /* too big */ ||
555 (token
= gettoken(&p
)) == NULL
||
556 (buffers
= simple_strtol(token
, NULL
, 0)) <= 0 ||
558 printk(KERN_ERR
"snd-page-alloc: invalid proc write format\n");
566 while ((pci
= pci_get_device(vendor
, device
, pci
)) != NULL
) {
567 if (mask
> 0 && mask
< 0xffffffff) {
568 if (pci_set_dma_mask(pci
, mask
) < 0 ||
569 pci_set_consistent_dma_mask(pci
, mask
) < 0) {
570 printk(KERN_ERR
"snd-page-alloc: cannot set DMA mask %lx for pci %04x:%04x\n", mask
, vendor
, device
);
575 for (i
= 0; i
< buffers
; i
++) {
576 struct snd_dma_buffer dmab
;
577 memset(&dmab
, 0, sizeof(dmab
));
578 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV
, snd_dma_pci_data(pci
),
580 printk(KERN_ERR
"snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size
);
584 snd_dma_reserve_buf(&dmab
, snd_dma_pci_buf_id(pci
));
589 for (i
= 0; i
< buffers
; i
++) {
590 struct snd_dma_buffer dmab
;
591 memset(&dmab
, 0, sizeof(dmab
));
592 /* FIXME: We can allocate only in ZONE_DMA
593 * without a device pointer!
595 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV
, NULL
,
597 printk(KERN_ERR
"snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size
);
600 snd_dma_reserve_buf(&dmab
, (unsigned int)((vendor
<< 16) | device
));
603 } else if (strcmp(token
, "erase") == 0)
604 /* FIXME: need for releasing each buffer chunk? */
605 free_all_reserved_pages();
607 printk(KERN_ERR
"snd-page-alloc: invalid proc cmd\n");
610 #endif /* CONFIG_PCI */
612 static const struct file_operations snd_mem_proc_fops
= {
613 .owner
= THIS_MODULE
,
614 .open
= snd_mem_proc_open
,
617 .write
= snd_mem_proc_write
,
620 .release
= single_release
,
623 #endif /* CONFIG_PROC_FS */
629 static int __init
snd_mem_init(void)
631 #ifdef CONFIG_PROC_FS
632 snd_mem_proc
= create_proc_entry(SND_MEM_PROC_FILE
, 0644, NULL
);
634 snd_mem_proc
->proc_fops
= &snd_mem_proc_fops
;
639 static void __exit
snd_mem_exit(void)
641 remove_proc_entry(SND_MEM_PROC_FILE
, NULL
);
642 free_all_reserved_pages();
643 if (snd_allocated_pages
> 0)
644 printk(KERN_ERR
"snd-malloc: Memory leak? pages not freed = %li\n", snd_allocated_pages
);
648 module_init(snd_mem_init
)
649 module_exit(snd_mem_exit
)
655 EXPORT_SYMBOL(snd_dma_alloc_pages
);
656 EXPORT_SYMBOL(snd_dma_alloc_pages_fallback
);
657 EXPORT_SYMBOL(snd_dma_free_pages
);
659 EXPORT_SYMBOL(snd_dma_get_reserved_buf
);
660 EXPORT_SYMBOL(snd_dma_reserve_buf
);
662 EXPORT_SYMBOL(snd_malloc_pages
);
663 EXPORT_SYMBOL(snd_free_pages
);