Merge branch 'linus' into release
[linux-2.6] / sound / pci / emu10k1 / memory.c
1 /*
2  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
3  *  Copyright (c) by Takashi Iwai <tiwai@suse.de>
4  *
5  *  EMU10K1 memory page allocation (PTB area)
6  *
7  *
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.
12  *
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.
17  *
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
21  *
22  */
23
24 #include <linux/pci.h>
25 #include <linux/time.h>
26 #include <linux/mutex.h>
27
28 #include <sound/core.h>
29 #include <sound/emu10k1.h>
30
31 /* page arguments of these two macros are Emu page (4096 bytes), not like
32  * aligned pages in others
33  */
34 #define __set_ptb_entry(emu,page,addr) \
35         (((u32 *)(emu)->ptb_pages.area)[page] = cpu_to_le32(((addr) << 1) | (page)))
36
37 #define UNIT_PAGES              (PAGE_SIZE / EMUPAGESIZE)
38 #define MAX_ALIGN_PAGES         (MAXPAGES / UNIT_PAGES)
39 /* get aligned page from offset address */
40 #define get_aligned_page(offset)        ((offset) >> PAGE_SHIFT)
41 /* get offset address from aligned page */
42 #define aligned_page_offset(page)       ((page) << PAGE_SHIFT)
43
44 #if PAGE_SIZE == 4096
45 /* page size == EMUPAGESIZE */
46 /* fill PTB entrie(s) corresponding to page with addr */
47 #define set_ptb_entry(emu,page,addr)    __set_ptb_entry(emu,page,addr)
48 /* fill PTB entrie(s) corresponding to page with silence pointer */
49 #define set_silent_ptb(emu,page)        __set_ptb_entry(emu,page,emu->silent_page.addr)
50 #else
51 /* fill PTB entries -- we need to fill UNIT_PAGES entries */
52 static inline void set_ptb_entry(struct snd_emu10k1 *emu, int page, dma_addr_t addr)
53 {
54         int i;
55         page *= UNIT_PAGES;
56         for (i = 0; i < UNIT_PAGES; i++, page++) {
57                 __set_ptb_entry(emu, page, addr);
58                 addr += EMUPAGESIZE;
59         }
60 }
61 static inline void set_silent_ptb(struct snd_emu10k1 *emu, int page)
62 {
63         int i;
64         page *= UNIT_PAGES;
65         for (i = 0; i < UNIT_PAGES; i++, page++)
66                 /* do not increment ptr */
67                 __set_ptb_entry(emu, page, emu->silent_page.addr);
68 }
69 #endif /* PAGE_SIZE */
70
71
72 /*
73  */
74 static int synth_alloc_pages(struct snd_emu10k1 *hw, struct snd_emu10k1_memblk *blk);
75 static int synth_free_pages(struct snd_emu10k1 *hw, struct snd_emu10k1_memblk *blk);
76
77 #define get_emu10k1_memblk(l,member)    list_entry(l, struct snd_emu10k1_memblk, member)
78
79
80 /* initialize emu10k1 part */
81 static void emu10k1_memblk_init(struct snd_emu10k1_memblk *blk)
82 {
83         blk->mapped_page = -1;
84         INIT_LIST_HEAD(&blk->mapped_link);
85         INIT_LIST_HEAD(&blk->mapped_order_link);
86         blk->map_locked = 0;
87
88         blk->first_page = get_aligned_page(blk->mem.offset);
89         blk->last_page = get_aligned_page(blk->mem.offset + blk->mem.size - 1);
90         blk->pages = blk->last_page - blk->first_page + 1;
91 }
92
93 /*
94  * search empty region on PTB with the given size
95  *
96  * if an empty region is found, return the page and store the next mapped block
97  * in nextp
98  * if not found, return a negative error code.
99  */
100 static int search_empty_map_area(struct snd_emu10k1 *emu, int npages, struct list_head **nextp)
101 {
102         int page = 0, found_page = -ENOMEM;
103         int max_size = npages;
104         int size;
105         struct list_head *candidate = &emu->mapped_link_head;
106         struct list_head *pos;
107
108         list_for_each (pos, &emu->mapped_link_head) {
109                 struct snd_emu10k1_memblk *blk = get_emu10k1_memblk(pos, mapped_link);
110                 if (blk->mapped_page < 0)
111                         continue;
112                 size = blk->mapped_page - page;
113                 if (size == npages) {
114                         *nextp = pos;
115                         return page;
116                 }
117                 else if (size > max_size) {
118                         /* we look for the maximum empty hole */
119                         max_size = size;
120                         candidate = pos;
121                         found_page = page;
122                 }
123                 page = blk->mapped_page + blk->pages;
124         }
125         size = MAX_ALIGN_PAGES - page;
126         if (size >= max_size) {
127                 *nextp = pos;
128                 return page;
129         }
130         *nextp = candidate;
131         return found_page;
132 }
133
134 /*
135  * map a memory block onto emu10k1's PTB
136  *
137  * call with memblk_lock held
138  */
139 static int map_memblk(struct snd_emu10k1 *emu, struct snd_emu10k1_memblk *blk)
140 {
141         int page, pg;
142         struct list_head *next;
143
144         page = search_empty_map_area(emu, blk->pages, &next);
145         if (page < 0) /* not found */
146                 return page;
147         /* insert this block in the proper position of mapped list */
148         list_add_tail(&blk->mapped_link, next);
149         /* append this as a newest block in order list */
150         list_add_tail(&blk->mapped_order_link, &emu->mapped_order_link_head);
151         blk->mapped_page = page;
152         /* fill PTB */
153         for (pg = blk->first_page; pg <= blk->last_page; pg++) {
154                 set_ptb_entry(emu, page, emu->page_addr_table[pg]);
155                 page++;
156         }
157         return 0;
158 }
159
160 /*
161  * unmap the block
162  * return the size of resultant empty pages
163  *
164  * call with memblk_lock held
165  */
166 static int unmap_memblk(struct snd_emu10k1 *emu, struct snd_emu10k1_memblk *blk)
167 {
168         int start_page, end_page, mpage, pg;
169         struct list_head *p;
170         struct snd_emu10k1_memblk *q;
171
172         /* calculate the expected size of empty region */
173         if ((p = blk->mapped_link.prev) != &emu->mapped_link_head) {
174                 q = get_emu10k1_memblk(p, mapped_link);
175                 start_page = q->mapped_page + q->pages;
176         } else
177                 start_page = 0;
178         if ((p = blk->mapped_link.next) != &emu->mapped_link_head) {
179                 q = get_emu10k1_memblk(p, mapped_link);
180                 end_page = q->mapped_page;
181         } else
182                 end_page = MAX_ALIGN_PAGES;
183
184         /* remove links */
185         list_del(&blk->mapped_link);
186         list_del(&blk->mapped_order_link);
187         /* clear PTB */
188         mpage = blk->mapped_page;
189         for (pg = blk->first_page; pg <= blk->last_page; pg++) {
190                 set_silent_ptb(emu, mpage);
191                 mpage++;
192         }
193         blk->mapped_page = -1;
194         return end_page - start_page; /* return the new empty size */
195 }
196
197 /*
198  * search empty pages with the given size, and create a memory block
199  *
200  * unlike synth_alloc the memory block is aligned to the page start
201  */
202 static struct snd_emu10k1_memblk *
203 search_empty(struct snd_emu10k1 *emu, int size)
204 {
205         struct list_head *p;
206         struct snd_emu10k1_memblk *blk;
207         int page, psize;
208
209         psize = get_aligned_page(size + PAGE_SIZE -1);
210         page = 0;
211         list_for_each(p, &emu->memhdr->block) {
212                 blk = get_emu10k1_memblk(p, mem.list);
213                 if (page + psize <= blk->first_page)
214                         goto __found_pages;
215                 page = blk->last_page + 1;
216         }
217         if (page + psize > emu->max_cache_pages)
218                 return NULL;
219
220 __found_pages:
221         /* create a new memory block */
222         blk = (struct snd_emu10k1_memblk *)__snd_util_memblk_new(emu->memhdr, psize << PAGE_SHIFT, p->prev);
223         if (blk == NULL)
224                 return NULL;
225         blk->mem.offset = aligned_page_offset(page); /* set aligned offset */
226         emu10k1_memblk_init(blk);
227         return blk;
228 }
229
230
231 /*
232  * check if the given pointer is valid for pages
233  */
234 static int is_valid_page(struct snd_emu10k1 *emu, dma_addr_t addr)
235 {
236         if (addr & ~emu->dma_mask) {
237                 snd_printk(KERN_ERR "max memory size is 0x%lx (addr = 0x%lx)!!\n", emu->dma_mask, (unsigned long)addr);
238                 return 0;
239         }
240         if (addr & (EMUPAGESIZE-1)) {
241                 snd_printk(KERN_ERR "page is not aligned\n");
242                 return 0;
243         }
244         return 1;
245 }
246
247 /*
248  * map the given memory block on PTB.
249  * if the block is already mapped, update the link order.
250  * if no empty pages are found, tries to release unsed memory blocks
251  * and retry the mapping.
252  */
253 int snd_emu10k1_memblk_map(struct snd_emu10k1 *emu, struct snd_emu10k1_memblk *blk)
254 {
255         int err;
256         int size;
257         struct list_head *p, *nextp;
258         struct snd_emu10k1_memblk *deleted;
259         unsigned long flags;
260
261         spin_lock_irqsave(&emu->memblk_lock, flags);
262         if (blk->mapped_page >= 0) {
263                 /* update order link */
264                 list_del(&blk->mapped_order_link);
265                 list_add_tail(&blk->mapped_order_link, &emu->mapped_order_link_head);
266                 spin_unlock_irqrestore(&emu->memblk_lock, flags);
267                 return 0;
268         }
269         if ((err = map_memblk(emu, blk)) < 0) {
270                 /* no enough page - try to unmap some blocks */
271                 /* starting from the oldest block */
272                 p = emu->mapped_order_link_head.next;
273                 for (; p != &emu->mapped_order_link_head; p = nextp) {
274                         nextp = p->next;
275                         deleted = get_emu10k1_memblk(p, mapped_order_link);
276                         if (deleted->map_locked)
277                                 continue;
278                         size = unmap_memblk(emu, deleted);
279                         if (size >= blk->pages) {
280                                 /* ok the empty region is enough large */
281                                 err = map_memblk(emu, blk);
282                                 break;
283                         }
284                 }
285         }
286         spin_unlock_irqrestore(&emu->memblk_lock, flags);
287         return err;
288 }
289
290 EXPORT_SYMBOL(snd_emu10k1_memblk_map);
291
292 /*
293  * page allocation for DMA
294  */
295 struct snd_util_memblk *
296 snd_emu10k1_alloc_pages(struct snd_emu10k1 *emu, struct snd_pcm_substream *substream)
297 {
298         struct snd_pcm_runtime *runtime = substream->runtime;
299         struct snd_util_memhdr *hdr;
300         struct snd_emu10k1_memblk *blk;
301         int page, err, idx;
302
303         if (snd_BUG_ON(!emu))
304                 return NULL;
305         if (snd_BUG_ON(runtime->dma_bytes <= 0 ||
306                        runtime->dma_bytes >= MAXPAGES * EMUPAGESIZE))
307                 return NULL;
308         hdr = emu->memhdr;
309         if (snd_BUG_ON(!hdr))
310                 return NULL;
311
312         mutex_lock(&hdr->block_mutex);
313         blk = search_empty(emu, runtime->dma_bytes);
314         if (blk == NULL) {
315                 mutex_unlock(&hdr->block_mutex);
316                 return NULL;
317         }
318         /* fill buffer addresses but pointers are not stored so that
319          * snd_free_pci_page() is not called in in synth_free()
320          */
321         idx = 0;
322         for (page = blk->first_page; page <= blk->last_page; page++, idx++) {
323                 unsigned long ofs = idx << PAGE_SHIFT;
324                 dma_addr_t addr;
325                 addr = snd_pcm_sgbuf_get_addr(substream, ofs);
326                 if (! is_valid_page(emu, addr)) {
327                         printk(KERN_ERR "emu: failure page = %d\n", idx);
328                         mutex_unlock(&hdr->block_mutex);
329                         return NULL;
330                 }
331                 emu->page_addr_table[page] = addr;
332                 emu->page_ptr_table[page] = NULL;
333         }
334
335         /* set PTB entries */
336         blk->map_locked = 1; /* do not unmap this block! */
337         err = snd_emu10k1_memblk_map(emu, blk);
338         if (err < 0) {
339                 __snd_util_mem_free(hdr, (struct snd_util_memblk *)blk);
340                 mutex_unlock(&hdr->block_mutex);
341                 return NULL;
342         }
343         mutex_unlock(&hdr->block_mutex);
344         return (struct snd_util_memblk *)blk;
345 }
346
347
348 /*
349  * release DMA buffer from page table
350  */
351 int snd_emu10k1_free_pages(struct snd_emu10k1 *emu, struct snd_util_memblk *blk)
352 {
353         if (snd_BUG_ON(!emu || !blk))
354                 return -EINVAL;
355         return snd_emu10k1_synth_free(emu, blk);
356 }
357
358
359 /*
360  * memory allocation using multiple pages (for synth)
361  * Unlike the DMA allocation above, non-contiguous pages are assined.
362  */
363
364 /*
365  * allocate a synth sample area
366  */
367 struct snd_util_memblk *
368 snd_emu10k1_synth_alloc(struct snd_emu10k1 *hw, unsigned int size)
369 {
370         struct snd_emu10k1_memblk *blk;
371         struct snd_util_memhdr *hdr = hw->memhdr; 
372
373         mutex_lock(&hdr->block_mutex);
374         blk = (struct snd_emu10k1_memblk *)__snd_util_mem_alloc(hdr, size);
375         if (blk == NULL) {
376                 mutex_unlock(&hdr->block_mutex);
377                 return NULL;
378         }
379         if (synth_alloc_pages(hw, blk)) {
380                 __snd_util_mem_free(hdr, (struct snd_util_memblk *)blk);
381                 mutex_unlock(&hdr->block_mutex);
382                 return NULL;
383         }
384         snd_emu10k1_memblk_map(hw, blk);
385         mutex_unlock(&hdr->block_mutex);
386         return (struct snd_util_memblk *)blk;
387 }
388
389 EXPORT_SYMBOL(snd_emu10k1_synth_alloc);
390
391 /*
392  * free a synth sample area
393  */
394 int
395 snd_emu10k1_synth_free(struct snd_emu10k1 *emu, struct snd_util_memblk *memblk)
396 {
397         struct snd_util_memhdr *hdr = emu->memhdr; 
398         struct snd_emu10k1_memblk *blk = (struct snd_emu10k1_memblk *)memblk;
399         unsigned long flags;
400
401         mutex_lock(&hdr->block_mutex);
402         spin_lock_irqsave(&emu->memblk_lock, flags);
403         if (blk->mapped_page >= 0)
404                 unmap_memblk(emu, blk);
405         spin_unlock_irqrestore(&emu->memblk_lock, flags);
406         synth_free_pages(emu, blk);
407          __snd_util_mem_free(hdr, memblk);
408         mutex_unlock(&hdr->block_mutex);
409         return 0;
410 }
411
412 EXPORT_SYMBOL(snd_emu10k1_synth_free);
413
414 /* check new allocation range */
415 static void get_single_page_range(struct snd_util_memhdr *hdr,
416                                   struct snd_emu10k1_memblk *blk,
417                                   int *first_page_ret, int *last_page_ret)
418 {
419         struct list_head *p;
420         struct snd_emu10k1_memblk *q;
421         int first_page, last_page;
422         first_page = blk->first_page;
423         if ((p = blk->mem.list.prev) != &hdr->block) {
424                 q = get_emu10k1_memblk(p, mem.list);
425                 if (q->last_page == first_page)
426                         first_page++;  /* first page was already allocated */
427         }
428         last_page = blk->last_page;
429         if ((p = blk->mem.list.next) != &hdr->block) {
430                 q = get_emu10k1_memblk(p, mem.list);
431                 if (q->first_page == last_page)
432                         last_page--; /* last page was already allocated */
433         }
434         *first_page_ret = first_page;
435         *last_page_ret = last_page;
436 }
437
438 /* release allocated pages */
439 static void __synth_free_pages(struct snd_emu10k1 *emu, int first_page,
440                                int last_page)
441 {
442         int page;
443
444         for (page = first_page; page <= last_page; page++) {
445                 free_page((unsigned long)emu->page_ptr_table[page]);
446                 emu->page_addr_table[page] = 0;
447                 emu->page_ptr_table[page] = NULL;
448         }
449 }
450
451 /*
452  * allocate kernel pages
453  */
454 static int synth_alloc_pages(struct snd_emu10k1 *emu, struct snd_emu10k1_memblk *blk)
455 {
456         int page, first_page, last_page;
457
458         emu10k1_memblk_init(blk);
459         get_single_page_range(emu->memhdr, blk, &first_page, &last_page);
460         /* allocate kernel pages */
461         for (page = first_page; page <= last_page; page++) {
462                 /* first try to allocate from <4GB zone */
463                 struct page *p = alloc_page(GFP_KERNEL | GFP_DMA32 |
464                                             __GFP_NOWARN);
465                 if (!p || (page_to_pfn(p) & ~(emu->dma_mask >> PAGE_SHIFT))) {
466                         if (p)
467                                 __free_page(p);
468                         /* try to allocate from <16MB zone */
469                         p = alloc_page(GFP_ATOMIC | GFP_DMA |
470                                        __GFP_NORETRY | /* no OOM-killer */
471                                        __GFP_NOWARN);
472                 }
473                 if (!p) {
474                         __synth_free_pages(emu, first_page, page - 1);
475                         return -ENOMEM;
476                 }
477                 emu->page_addr_table[page] = page_to_phys(p);
478                 emu->page_ptr_table[page] = page_address(p);
479         }
480         return 0;
481 }
482
483 /*
484  * free pages
485  */
486 static int synth_free_pages(struct snd_emu10k1 *emu, struct snd_emu10k1_memblk *blk)
487 {
488         int first_page, last_page;
489
490         get_single_page_range(emu->memhdr, blk, &first_page, &last_page);
491         __synth_free_pages(emu, first_page, last_page);
492         return 0;
493 }
494
495 /* calculate buffer pointer from offset address */
496 static inline void *offset_ptr(struct snd_emu10k1 *emu, int page, int offset)
497 {
498         char *ptr;
499         if (snd_BUG_ON(page < 0 || page >= emu->max_cache_pages))
500                 return NULL;
501         ptr = emu->page_ptr_table[page];
502         if (! ptr) {
503                 printk(KERN_ERR "emu10k1: access to NULL ptr: page = %d\n", page);
504                 return NULL;
505         }
506         ptr += offset & (PAGE_SIZE - 1);
507         return (void*)ptr;
508 }
509
510 /*
511  * bzero(blk + offset, size)
512  */
513 int snd_emu10k1_synth_bzero(struct snd_emu10k1 *emu, struct snd_util_memblk *blk,
514                             int offset, int size)
515 {
516         int page, nextofs, end_offset, temp, temp1;
517         void *ptr;
518         struct snd_emu10k1_memblk *p = (struct snd_emu10k1_memblk *)blk;
519
520         offset += blk->offset & (PAGE_SIZE - 1);
521         end_offset = offset + size;
522         page = get_aligned_page(offset);
523         do {
524                 nextofs = aligned_page_offset(page + 1);
525                 temp = nextofs - offset;
526                 temp1 = end_offset - offset;
527                 if (temp1 < temp)
528                         temp = temp1;
529                 ptr = offset_ptr(emu, page + p->first_page, offset);
530                 if (ptr)
531                         memset(ptr, 0, temp);
532                 offset = nextofs;
533                 page++;
534         } while (offset < end_offset);
535         return 0;
536 }
537
538 EXPORT_SYMBOL(snd_emu10k1_synth_bzero);
539
540 /*
541  * copy_from_user(blk + offset, data, size)
542  */
543 int snd_emu10k1_synth_copy_from_user(struct snd_emu10k1 *emu, struct snd_util_memblk *blk,
544                                      int offset, const char __user *data, int size)
545 {
546         int page, nextofs, end_offset, temp, temp1;
547         void *ptr;
548         struct snd_emu10k1_memblk *p = (struct snd_emu10k1_memblk *)blk;
549
550         offset += blk->offset & (PAGE_SIZE - 1);
551         end_offset = offset + size;
552         page = get_aligned_page(offset);
553         do {
554                 nextofs = aligned_page_offset(page + 1);
555                 temp = nextofs - offset;
556                 temp1 = end_offset - offset;
557                 if (temp1 < temp)
558                         temp = temp1;
559                 ptr = offset_ptr(emu, page + p->first_page, offset);
560                 if (ptr && copy_from_user(ptr, data, temp))
561                         return -EFAULT;
562                 offset = nextofs;
563                 data += temp;
564                 page++;
565         } while (offset < end_offset);
566         return 0;
567 }
568
569 EXPORT_SYMBOL(snd_emu10k1_synth_copy_from_user);