1/*
2 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
3 *  GUS's memory allocation routines / bottom layer
4 *
5 *
6 *   This program is free software; you can redistribute it and/or modify
7 *   it under the terms of the GNU General Public License as published by
8 *   the Free Software Foundation; either version 2 of the License, or
9 *   (at your option) any later version.
10 *
11 *   This program is distributed in the hope that it will be useful,
12 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 *   GNU General Public License for more details.
15 *
16 *   You should have received a copy of the GNU General Public License
17 *   along with this program; if not, write to the Free Software
18 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 *
20 */
21
22#include <linux/slab.h>
23#include <linux/string.h>
24#include <sound/core.h>
25#include <sound/gus.h>
26#include <sound/info.h>
27
28#ifdef CONFIG_SND_DEBUG
29static void snd_gf1_mem_info_read(struct snd_info_entry *entry,
30				  struct snd_info_buffer *buffer);
31#endif
32
33void snd_gf1_mem_lock(struct snd_gf1_mem * alloc, int xup)
34{
35	if (!xup) {
36		mutex_lock(&alloc->memory_mutex);
37	} else {
38		mutex_unlock(&alloc->memory_mutex);
39	}
40}
41
42static struct snd_gf1_mem_block *snd_gf1_mem_xalloc(struct snd_gf1_mem * alloc,
43					       struct snd_gf1_mem_block * block)
44{
45	struct snd_gf1_mem_block *pblock, *nblock;
46
47	nblock = kmalloc(sizeof(struct snd_gf1_mem_block), GFP_KERNEL);
48	if (nblock == NULL)
49		return NULL;
50	*nblock = *block;
51	pblock = alloc->first;
52	while (pblock) {
53		if (pblock->ptr > nblock->ptr) {
54			nblock->prev = pblock->prev;
55			nblock->next = pblock;
56			pblock->prev = nblock;
57			if (pblock == alloc->first)
58				alloc->first = nblock;
59			else
60				nblock->prev->next = nblock;
61			mutex_unlock(&alloc->memory_mutex);
62			return NULL;
63		}
64		pblock = pblock->next;
65	}
66	nblock->next = NULL;
67	if (alloc->last == NULL) {
68		nblock->prev = NULL;
69		alloc->first = alloc->last = nblock;
70	} else {
71		nblock->prev = alloc->last;
72		alloc->last->next = nblock;
73		alloc->last = nblock;
74	}
75	return nblock;
76}
77
78int snd_gf1_mem_xfree(struct snd_gf1_mem * alloc, struct snd_gf1_mem_block * block)
79{
80	if (block->share) {	/* ok.. shared block */
81		block->share--;
82		mutex_unlock(&alloc->memory_mutex);
83		return 0;
84	}
85	if (alloc->first == block) {
86		alloc->first = block->next;
87		if (block->next)
88			block->next->prev = NULL;
89	} else {
90		block->prev->next = block->next;
91		if (block->next)
92			block->next->prev = block->prev;
93	}
94	if (alloc->last == block) {
95		alloc->last = block->prev;
96		if (block->prev)
97			block->prev->next = NULL;
98	} else {
99		block->next->prev = block->prev;
100		if (block->prev)
101			block->prev->next = block->next;
102	}
103	kfree(block->name);
104	kfree(block);
105	return 0;
106}
107
108static struct snd_gf1_mem_block *snd_gf1_mem_look(struct snd_gf1_mem * alloc,
109					     unsigned int address)
110{
111	struct snd_gf1_mem_block *block;
112
113	for (block = alloc->first; block; block = block->next) {
114		if (block->ptr == address) {
115			return block;
116		}
117	}
118	return NULL;
119}
120
121static struct snd_gf1_mem_block *snd_gf1_mem_share(struct snd_gf1_mem * alloc,
122					      unsigned int *share_id)
123{
124	struct snd_gf1_mem_block *block;
125
126	if (!share_id[0] && !share_id[1] &&
127	    !share_id[2] && !share_id[3])
128		return NULL;
129	for (block = alloc->first; block; block = block->next)
130		if (!memcmp(share_id, block->share_id,
131				sizeof(block->share_id)))
132			return block;
133	return NULL;
134}
135
136static int snd_gf1_mem_find(struct snd_gf1_mem * alloc,
137			    struct snd_gf1_mem_block * block,
138			    unsigned int size, int w_16, int align)
139{
140	struct snd_gf1_bank_info *info = w_16 ? alloc->banks_16 : alloc->banks_8;
141	unsigned int idx, boundary;
142	int size1;
143	struct snd_gf1_mem_block *pblock;
144	unsigned int ptr1, ptr2;
145
146	if (w_16 && align < 2)
147		align = 2;
148	block->flags = w_16 ? SNDRV_GF1_MEM_BLOCK_16BIT : 0;
149	block->owner = SNDRV_GF1_MEM_OWNER_DRIVER;
150	block->share = 0;
151	block->share_id[0] = block->share_id[1] =
152	block->share_id[2] = block->share_id[3] = 0;
153	block->name = NULL;
154	block->prev = block->next = NULL;
155	for (pblock = alloc->first, idx = 0; pblock; pblock = pblock->next) {
156		while (pblock->ptr >= (boundary = info[idx].address + info[idx].size))
157			idx++;
158		while (pblock->ptr + pblock->size >= (boundary = info[idx].address + info[idx].size))
159			idx++;
160		ptr2 = boundary;
161		if (pblock->next) {
162			if (pblock->ptr + pblock->size == pblock->next->ptr)
163				continue;
164			if (pblock->next->ptr < boundary)
165				ptr2 = pblock->next->ptr;
166		}
167		ptr1 = ALIGN(pblock->ptr + pblock->size, align);
168		if (ptr1 >= ptr2)
169			continue;
170		size1 = ptr2 - ptr1;
171		if ((int)size <= size1) {
172			block->ptr = ptr1;
173			block->size = size;
174			return 0;
175		}
176	}
177	while (++idx < 4) {
178		if (size <= info[idx].size) {
179			/* I assume that bank address is already aligned.. */
180			block->ptr = info[idx].address;
181			block->size = size;
182			return 0;
183		}
184	}
185	return -ENOMEM;
186}
187
188struct snd_gf1_mem_block *snd_gf1_mem_alloc(struct snd_gf1_mem * alloc, int owner,
189				       char *name, int size, int w_16, int align,
190				       unsigned int *share_id)
191{
192	struct snd_gf1_mem_block block, *nblock;
193
194	snd_gf1_mem_lock(alloc, 0);
195	if (share_id != NULL) {
196		nblock = snd_gf1_mem_share(alloc, share_id);
197		if (nblock != NULL) {
198			if (size != (int)nblock->size) {
199				/* TODO: remove in the future */
200				snd_printk(KERN_ERR "snd_gf1_mem_alloc - share: sizes differ\n");
201				goto __std;
202			}
203			nblock->share++;
204			snd_gf1_mem_lock(alloc, 1);
205			return NULL;
206		}
207	}
208      __std:
209	if (snd_gf1_mem_find(alloc, &block, size, w_16, align) < 0) {
210		snd_gf1_mem_lock(alloc, 1);
211		return NULL;
212	}
213	if (share_id != NULL)
214		memcpy(&block.share_id, share_id, sizeof(block.share_id));
215	block.owner = owner;
216	block.name = kstrdup(name, GFP_KERNEL);
217	nblock = snd_gf1_mem_xalloc(alloc, &block);
218	snd_gf1_mem_lock(alloc, 1);
219	return nblock;
220}
221
222int snd_gf1_mem_free(struct snd_gf1_mem * alloc, unsigned int address)
223{
224	int result;
225	struct snd_gf1_mem_block *block;
226
227	snd_gf1_mem_lock(alloc, 0);
228	if ((block = snd_gf1_mem_look(alloc, address)) != NULL) {
229		result = snd_gf1_mem_xfree(alloc, block);
230		snd_gf1_mem_lock(alloc, 1);
231		return result;
232	}
233	snd_gf1_mem_lock(alloc, 1);
234	return -EINVAL;
235}
236
237int snd_gf1_mem_init(struct snd_gus_card * gus)
238{
239	struct snd_gf1_mem *alloc;
240	struct snd_gf1_mem_block block;
241#ifdef CONFIG_SND_DEBUG
242	struct snd_info_entry *entry;
243#endif
244
245	alloc = &gus->gf1.mem_alloc;
246	mutex_init(&alloc->memory_mutex);
247	alloc->first = alloc->last = NULL;
248	if (!gus->gf1.memory)
249		return 0;
250
251	memset(&block, 0, sizeof(block));
252	block.owner = SNDRV_GF1_MEM_OWNER_DRIVER;
253	if (gus->gf1.enh_mode) {
254		block.ptr = 0;
255		block.size = 1024;
256		block.name = kstrdup("InterWave LFOs", GFP_KERNEL);
257		if (snd_gf1_mem_xalloc(alloc, &block) == NULL)
258			return -ENOMEM;
259	}
260	block.ptr = gus->gf1.default_voice_address;
261	block.size = 4;
262	block.name = kstrdup("Voice default (NULL's)", GFP_KERNEL);
263	if (snd_gf1_mem_xalloc(alloc, &block) == NULL)
264		return -ENOMEM;
265#ifdef CONFIG_SND_DEBUG
266	if (! snd_card_proc_new(gus->card, "gusmem", &entry))
267		snd_info_set_text_ops(entry, gus, snd_gf1_mem_info_read);
268#endif
269	return 0;
270}
271
272int snd_gf1_mem_done(struct snd_gus_card * gus)
273{
274	struct snd_gf1_mem *alloc;
275	struct snd_gf1_mem_block *block, *nblock;
276
277	alloc = &gus->gf1.mem_alloc;
278	block = alloc->first;
279	while (block) {
280		nblock = block->next;
281		snd_gf1_mem_xfree(alloc, block);
282		block = nblock;
283	}
284	return 0;
285}
286
287#ifdef CONFIG_SND_DEBUG
288static void snd_gf1_mem_info_read(struct snd_info_entry *entry,
289				  struct snd_info_buffer *buffer)
290{
291	struct snd_gus_card *gus;
292	struct snd_gf1_mem *alloc;
293	struct snd_gf1_mem_block *block;
294	unsigned int total, used;
295	int i;
296
297	gus = entry->private_data;
298	alloc = &gus->gf1.mem_alloc;
299	mutex_lock(&alloc->memory_mutex);
300	snd_iprintf(buffer, "8-bit banks       : \n    ");
301	for (i = 0; i < 4; i++)
302		snd_iprintf(buffer, "0x%06x (%04ik)%s", alloc->banks_8[i].address, alloc->banks_8[i].size >> 10, i + 1 < 4 ? "," : "");
303	snd_iprintf(buffer, "\n"
304		    "16-bit banks      : \n    ");
305	for (i = total = 0; i < 4; i++) {
306		snd_iprintf(buffer, "0x%06x (%04ik)%s", alloc->banks_16[i].address, alloc->banks_16[i].size >> 10, i + 1 < 4 ? "," : "");
307		total += alloc->banks_16[i].size;
308	}
309	snd_iprintf(buffer, "\n");
310	used = 0;
311	for (block = alloc->first, i = 0; block; block = block->next, i++) {
312		used += block->size;
313		snd_iprintf(buffer, "Block %i at 0x%lx onboard 0x%x size %i (0x%x):\n", i, (long) block, block->ptr, block->size, block->size);
314		if (block->share ||
315		    block->share_id[0] || block->share_id[1] ||
316		    block->share_id[2] || block->share_id[3])
317			snd_iprintf(buffer, "  Share           : %i [id0 0x%x] [id1 0x%x] [id2 0x%x] [id3 0x%x]\n",
318				block->share,
319				block->share_id[0], block->share_id[1],
320				block->share_id[2], block->share_id[3]);
321		snd_iprintf(buffer, "  Flags           :%s\n",
322		block->flags & SNDRV_GF1_MEM_BLOCK_16BIT ? " 16-bit" : "");
323		snd_iprintf(buffer, "  Owner           : ");
324		switch (block->owner) {
325		case SNDRV_GF1_MEM_OWNER_DRIVER:
326			snd_iprintf(buffer, "driver - %s\n", block->name);
327			break;
328		case SNDRV_GF1_MEM_OWNER_WAVE_SIMPLE:
329			snd_iprintf(buffer, "SIMPLE wave\n");
330			break;
331		case SNDRV_GF1_MEM_OWNER_WAVE_GF1:
332			snd_iprintf(buffer, "GF1 wave\n");
333			break;
334		case SNDRV_GF1_MEM_OWNER_WAVE_IWFFFF:
335			snd_iprintf(buffer, "IWFFFF wave\n");
336			break;
337		default:
338			snd_iprintf(buffer, "unknown\n");
339		}
340	}
341	snd_iprintf(buffer, "  Total: memory = %i, used = %i, free = %i\n",
342		    total, used, total - used);
343	mutex_unlock(&alloc->memory_mutex);
344#if 0
345	ultra_iprintf(buffer, "  Verify: free = %i, max 8-bit block = %i, max 16-bit block = %i\n",
346		      ultra_memory_free_size(card, &card->gf1.mem_alloc),
347		  ultra_memory_free_block(card, &card->gf1.mem_alloc, 0),
348		 ultra_memory_free_block(card, &card->gf1.mem_alloc, 1));
349#endif
350}
351#endif
352