xref: /linux/sound/sh/aica.c (revision bd7dd77c2a05c530684eea2e3af16449ae9c5d52)
1 /*
2 * This code is licenced under
3 * the General Public Licence
4 * version 2
5 *
6 * Copyright Adrian McMenamin 2005, 2006, 2007
7 * <adrian@mcmen.demon.co.uk>
8 * Requires firmware (BSD licenced) available from:
9 * http://linuxdc.cvs.sourceforge.net/linuxdc/linux-sh-dc/sound/oss/aica/firmware/
10 * or the maintainer
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as published by
14 * the Free Software Foundation.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 *
25 */
26 
27 #include <linux/init.h>
28 #include <linux/jiffies.h>
29 #include <linux/slab.h>
30 #include <linux/time.h>
31 #include <linux/wait.h>
32 #include <linux/moduleparam.h>
33 #include <linux/platform_device.h>
34 #include <linux/firmware.h>
35 #include <linux/timer.h>
36 #include <linux/delay.h>
37 #include <linux/workqueue.h>
38 #include <sound/core.h>
39 #include <sound/control.h>
40 #include <sound/pcm.h>
41 #include <sound/initval.h>
42 #include <sound/info.h>
43 #include <asm/io.h>
44 #include <asm/dma.h>
45 #include <mach/sysasic.h>
46 #include "aica.h"
47 
48 MODULE_AUTHOR("Adrian McMenamin <adrian@mcmen.demon.co.uk>");
49 MODULE_DESCRIPTION("Dreamcast AICA sound (pcm) driver");
50 MODULE_LICENSE("GPL");
51 MODULE_SUPPORTED_DEVICE("{{Yamaha/SEGA, AICA}}");
52 
53 /* module parameters */
54 #define CARD_NAME "AICA"
55 static int index = -1;
56 static char *id;
57 static int enable = 1;
58 module_param(index, int, 0444);
59 MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard.");
60 module_param(id, charp, 0444);
61 MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard.");
62 module_param(enable, bool, 0644);
63 MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard.");
64 
65 /* Use workqueue */
66 static struct workqueue_struct *aica_queue;
67 
68 /* Simple platform device */
69 static struct platform_device *pd;
70 static struct resource aica_memory_space[2] = {
71 	{
72 	 .name = "AICA ARM CONTROL",
73 	 .start = ARM_RESET_REGISTER,
74 	 .flags = IORESOURCE_MEM,
75 	 .end = ARM_RESET_REGISTER + 3,
76 	 },
77 	{
78 	 .name = "AICA Sound RAM",
79 	 .start = SPU_MEMORY_BASE,
80 	 .flags = IORESOURCE_MEM,
81 	 .end = SPU_MEMORY_BASE + 0x200000 - 1,
82 	 },
83 };
84 
85 /* SPU specific functions */
86 /* spu_write_wait - wait for G2-SH FIFO to clear */
87 static void spu_write_wait(void)
88 {
89 	int time_count;
90 	time_count = 0;
91 	while (1) {
92 		if (!(readl(G2_FIFO) & 0x11))
93 			break;
94 		/* To ensure hardware failure doesn't wedge kernel */
95 		time_count++;
96 		if (time_count > 0x10000) {
97 			snd_printk
98 			    ("WARNING: G2 FIFO appears to be blocked.\n");
99 			break;
100 		}
101 	}
102 }
103 
104 /* spu_memset - write to memory in SPU address space */
105 static void spu_memset(u32 toi, u32 what, int length)
106 {
107 	int i;
108 	unsigned long flags;
109 	if (snd_BUG_ON(length % 4))
110 		return;
111 	for (i = 0; i < length; i++) {
112 		if (!(i % 8))
113 			spu_write_wait();
114 		local_irq_save(flags);
115 		writel(what, toi + SPU_MEMORY_BASE);
116 		local_irq_restore(flags);
117 		toi++;
118 	}
119 }
120 
121 /* spu_memload - write to SPU address space */
122 static void spu_memload(u32 toi, void *from, int length)
123 {
124 	unsigned long flags;
125 	u32 *froml = from;
126 	u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
127 	int i;
128 	u32 val;
129 	length = DIV_ROUND_UP(length, 4);
130 	spu_write_wait();
131 	for (i = 0; i < length; i++) {
132 		if (!(i % 8))
133 			spu_write_wait();
134 		val = *froml;
135 		local_irq_save(flags);
136 		writel(val, to);
137 		local_irq_restore(flags);
138 		froml++;
139 		to++;
140 	}
141 }
142 
143 /* spu_disable - set spu registers to stop sound output */
144 static void spu_disable(void)
145 {
146 	int i;
147 	unsigned long flags;
148 	u32 regval;
149 	spu_write_wait();
150 	regval = readl(ARM_RESET_REGISTER);
151 	regval |= 1;
152 	spu_write_wait();
153 	local_irq_save(flags);
154 	writel(regval, ARM_RESET_REGISTER);
155 	local_irq_restore(flags);
156 	for (i = 0; i < 64; i++) {
157 		spu_write_wait();
158 		regval = readl(SPU_REGISTER_BASE + (i * 0x80));
159 		regval = (regval & ~0x4000) | 0x8000;
160 		spu_write_wait();
161 		local_irq_save(flags);
162 		writel(regval, SPU_REGISTER_BASE + (i * 0x80));
163 		local_irq_restore(flags);
164 	}
165 }
166 
167 /* spu_enable - set spu registers to enable sound output */
168 static void spu_enable(void)
169 {
170 	unsigned long flags;
171 	u32 regval = readl(ARM_RESET_REGISTER);
172 	regval &= ~1;
173 	spu_write_wait();
174 	local_irq_save(flags);
175 	writel(regval, ARM_RESET_REGISTER);
176 	local_irq_restore(flags);
177 }
178 
179 /*
180  * Halt the sound processor, clear the memory,
181  * load some default ARM7 code, and then restart ARM7
182 */
183 static void spu_reset(void)
184 {
185 	unsigned long flags;
186 	spu_disable();
187 	spu_memset(0, 0, 0x200000 / 4);
188 	/* Put ARM7 in endless loop */
189 	local_irq_save(flags);
190 	ctrl_outl(0xea000002, SPU_MEMORY_BASE);
191 	local_irq_restore(flags);
192 	spu_enable();
193 }
194 
195 /* aica_chn_start - write to spu to start playback */
196 static void aica_chn_start(void)
197 {
198 	unsigned long flags;
199 	spu_write_wait();
200 	local_irq_save(flags);
201 	writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
202 	local_irq_restore(flags);
203 }
204 
205 /* aica_chn_halt - write to spu to halt playback */
206 static void aica_chn_halt(void)
207 {
208 	unsigned long flags;
209 	spu_write_wait();
210 	local_irq_save(flags);
211 	writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
212 	local_irq_restore(flags);
213 }
214 
215 /* ALSA code below */
216 static struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
217 	.info = (SNDRV_PCM_INFO_NONINTERLEAVED),
218 	.formats =
219 	    (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
220 	     SNDRV_PCM_FMTBIT_IMA_ADPCM),
221 	.rates = SNDRV_PCM_RATE_8000_48000,
222 	.rate_min = 8000,
223 	.rate_max = 48000,
224 	.channels_min = 1,
225 	.channels_max = 2,
226 	.buffer_bytes_max = AICA_BUFFER_SIZE,
227 	.period_bytes_min = AICA_PERIOD_SIZE,
228 	.period_bytes_max = AICA_PERIOD_SIZE,
229 	.periods_min = AICA_PERIOD_NUMBER,
230 	.periods_max = AICA_PERIOD_NUMBER,
231 };
232 
233 static int aica_dma_transfer(int channels, int buffer_size,
234 			     struct snd_pcm_substream *substream)
235 {
236 	int q, err, period_offset;
237 	struct snd_card_aica *dreamcastcard;
238 	struct snd_pcm_runtime *runtime;
239 	unsigned long flags;
240 	err = 0;
241 	dreamcastcard = substream->pcm->private_data;
242 	period_offset = dreamcastcard->clicks;
243 	period_offset %= (AICA_PERIOD_NUMBER / channels);
244 	runtime = substream->runtime;
245 	for (q = 0; q < channels; q++) {
246 		local_irq_save(flags);
247 		err = dma_xfer(AICA_DMA_CHANNEL,
248 			       (unsigned long) (runtime->dma_area +
249 						(AICA_BUFFER_SIZE * q) /
250 						channels +
251 						AICA_PERIOD_SIZE *
252 						period_offset),
253 			       AICA_CHANNEL0_OFFSET + q * CHANNEL_OFFSET +
254 			       AICA_PERIOD_SIZE * period_offset,
255 			       buffer_size / channels, AICA_DMA_MODE);
256 		if (unlikely(err < 0)) {
257 			local_irq_restore(flags);
258 			break;
259 		}
260 		dma_wait_for_completion(AICA_DMA_CHANNEL);
261 		local_irq_restore(flags);
262 	}
263 	return err;
264 }
265 
266 static void startup_aica(struct snd_card_aica *dreamcastcard)
267 {
268 	spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
269 		    dreamcastcard->channel, sizeof(struct aica_channel));
270 	aica_chn_start();
271 }
272 
273 static void run_spu_dma(struct work_struct *work)
274 {
275 	int buffer_size;
276 	struct snd_pcm_runtime *runtime;
277 	struct snd_card_aica *dreamcastcard;
278 	dreamcastcard =
279 	    container_of(work, struct snd_card_aica, spu_dma_work);
280 	runtime = dreamcastcard->substream->runtime;
281 	if (unlikely(dreamcastcard->dma_check == 0)) {
282 		buffer_size =
283 		    frames_to_bytes(runtime, runtime->buffer_size);
284 		if (runtime->channels > 1)
285 			dreamcastcard->channel->flags |= 0x01;
286 		aica_dma_transfer(runtime->channels, buffer_size,
287 				  dreamcastcard->substream);
288 		startup_aica(dreamcastcard);
289 		dreamcastcard->clicks =
290 		    buffer_size / (AICA_PERIOD_SIZE * runtime->channels);
291 		return;
292 	} else {
293 		aica_dma_transfer(runtime->channels,
294 				  AICA_PERIOD_SIZE * runtime->channels,
295 				  dreamcastcard->substream);
296 		snd_pcm_period_elapsed(dreamcastcard->substream);
297 		dreamcastcard->clicks++;
298 		if (unlikely(dreamcastcard->clicks >= AICA_PERIOD_NUMBER))
299 			dreamcastcard->clicks %= AICA_PERIOD_NUMBER;
300 		mod_timer(&dreamcastcard->timer, jiffies + 1);
301 	}
302 }
303 
304 static void aica_period_elapsed(unsigned long timer_var)
305 {
306 	/*timer function - so cannot sleep */
307 	int play_period;
308 	struct snd_pcm_runtime *runtime;
309 	struct snd_pcm_substream *substream;
310 	struct snd_card_aica *dreamcastcard;
311 	substream = (struct snd_pcm_substream *) timer_var;
312 	runtime = substream->runtime;
313 	dreamcastcard = substream->pcm->private_data;
314 	/* Have we played out an additional period? */
315 	play_period =
316 	    frames_to_bytes(runtime,
317 			    readl
318 			    (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
319 	    AICA_PERIOD_SIZE;
320 	if (play_period == dreamcastcard->current_period) {
321 		/* reschedule the timer */
322 		mod_timer(&(dreamcastcard->timer), jiffies + 1);
323 		return;
324 	}
325 	if (runtime->channels > 1)
326 		dreamcastcard->current_period = play_period;
327 	if (unlikely(dreamcastcard->dma_check == 0))
328 		dreamcastcard->dma_check = 1;
329 	queue_work(aica_queue, &(dreamcastcard->spu_dma_work));
330 }
331 
332 static void spu_begin_dma(struct snd_pcm_substream *substream)
333 {
334 	struct snd_card_aica *dreamcastcard;
335 	struct snd_pcm_runtime *runtime;
336 	runtime = substream->runtime;
337 	dreamcastcard = substream->pcm->private_data;
338 	/*get the queue to do the work */
339 	queue_work(aica_queue, &(dreamcastcard->spu_dma_work));
340 	/* Timer may already be running */
341 	if (unlikely(dreamcastcard->timer.data)) {
342 		mod_timer(&dreamcastcard->timer, jiffies + 4);
343 		return;
344 	}
345 	init_timer(&(dreamcastcard->timer));
346 	dreamcastcard->timer.data = (unsigned long) substream;
347 	dreamcastcard->timer.function = aica_period_elapsed;
348 	dreamcastcard->timer.expires = jiffies + 4;
349 	add_timer(&(dreamcastcard->timer));
350 }
351 
352 static int snd_aicapcm_pcm_open(struct snd_pcm_substream
353 				*substream)
354 {
355 	struct snd_pcm_runtime *runtime;
356 	struct aica_channel *channel;
357 	struct snd_card_aica *dreamcastcard;
358 	if (!enable)
359 		return -ENOENT;
360 	dreamcastcard = substream->pcm->private_data;
361 	channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
362 	if (!channel)
363 		return -ENOMEM;
364 	/* set defaults for channel */
365 	channel->sfmt = SM_8BIT;
366 	channel->cmd = AICA_CMD_START;
367 	channel->vol = dreamcastcard->master_volume;
368 	channel->pan = 0x80;
369 	channel->pos = 0;
370 	channel->flags = 0;	/* default to mono */
371 	dreamcastcard->channel = channel;
372 	runtime = substream->runtime;
373 	runtime->hw = snd_pcm_aica_playback_hw;
374 	spu_enable();
375 	dreamcastcard->clicks = 0;
376 	dreamcastcard->current_period = 0;
377 	dreamcastcard->dma_check = 0;
378 	return 0;
379 }
380 
381 static int snd_aicapcm_pcm_close(struct snd_pcm_substream
382 				 *substream)
383 {
384 	struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
385 	flush_workqueue(aica_queue);
386 	if (dreamcastcard->timer.data)
387 		del_timer(&dreamcastcard->timer);
388 	kfree(dreamcastcard->channel);
389 	spu_disable();
390 	return 0;
391 }
392 
393 static int snd_aicapcm_pcm_hw_free(struct snd_pcm_substream
394 				   *substream)
395 {
396 	/* Free the DMA buffer */
397 	return snd_pcm_lib_free_pages(substream);
398 }
399 
400 static int snd_aicapcm_pcm_hw_params(struct snd_pcm_substream
401 				     *substream, struct snd_pcm_hw_params
402 				     *hw_params)
403 {
404 	/* Allocate a DMA buffer using ALSA built-ins */
405 	return
406 	    snd_pcm_lib_malloc_pages(substream,
407 				     params_buffer_bytes(hw_params));
408 }
409 
410 static int snd_aicapcm_pcm_prepare(struct snd_pcm_substream
411 				   *substream)
412 {
413 	struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
414 	if ((substream->runtime)->format == SNDRV_PCM_FORMAT_S16_LE)
415 		dreamcastcard->channel->sfmt = SM_16BIT;
416 	dreamcastcard->channel->freq = substream->runtime->rate;
417 	dreamcastcard->substream = substream;
418 	return 0;
419 }
420 
421 static int snd_aicapcm_pcm_trigger(struct snd_pcm_substream
422 				   *substream, int cmd)
423 {
424 	switch (cmd) {
425 	case SNDRV_PCM_TRIGGER_START:
426 		spu_begin_dma(substream);
427 		break;
428 	case SNDRV_PCM_TRIGGER_STOP:
429 		aica_chn_halt();
430 		break;
431 	default:
432 		return -EINVAL;
433 	}
434 	return 0;
435 }
436 
437 static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream
438 					     *substream)
439 {
440 	return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER);
441 }
442 
443 static struct snd_pcm_ops snd_aicapcm_playback_ops = {
444 	.open = snd_aicapcm_pcm_open,
445 	.close = snd_aicapcm_pcm_close,
446 	.ioctl = snd_pcm_lib_ioctl,
447 	.hw_params = snd_aicapcm_pcm_hw_params,
448 	.hw_free = snd_aicapcm_pcm_hw_free,
449 	.prepare = snd_aicapcm_pcm_prepare,
450 	.trigger = snd_aicapcm_pcm_trigger,
451 	.pointer = snd_aicapcm_pcm_pointer,
452 };
453 
454 /* TO DO: set up to handle more than one pcm instance */
455 static int __init snd_aicapcmchip(struct snd_card_aica
456 				  *dreamcastcard, int pcm_index)
457 {
458 	struct snd_pcm *pcm;
459 	int err;
460 	/* AICA has no capture ability */
461 	err =
462 	    snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
463 			&pcm);
464 	if (unlikely(err < 0))
465 		return err;
466 	pcm->private_data = dreamcastcard;
467 	strcpy(pcm->name, "AICA PCM");
468 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
469 			&snd_aicapcm_playback_ops);
470 	/* Allocate the DMA buffers */
471 	err =
472 	    snd_pcm_lib_preallocate_pages_for_all(pcm,
473 						  SNDRV_DMA_TYPE_CONTINUOUS,
474 						  snd_dma_continuous_data
475 						  (GFP_KERNEL),
476 						  AICA_BUFFER_SIZE,
477 						  AICA_BUFFER_SIZE);
478 	return err;
479 }
480 
481 /* Mixer controls */
482 #define aica_pcmswitch_info		snd_ctl_boolean_mono_info
483 
484 static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
485 			      struct snd_ctl_elem_value *ucontrol)
486 {
487 	ucontrol->value.integer.value[0] = 1;	/* TO DO: Fix me */
488 	return 0;
489 }
490 
491 static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
492 			      struct snd_ctl_elem_value *ucontrol)
493 {
494 	if (ucontrol->value.integer.value[0] == 1)
495 		return 0;	/* TO DO: Fix me */
496 	else
497 		aica_chn_halt();
498 	return 0;
499 }
500 
501 static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
502 			       struct snd_ctl_elem_info *uinfo)
503 {
504 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
505 	uinfo->count = 1;
506 	uinfo->value.integer.min = 0;
507 	uinfo->value.integer.max = 0xFF;
508 	return 0;
509 }
510 
511 static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
512 			      struct snd_ctl_elem_value *ucontrol)
513 {
514 	struct snd_card_aica *dreamcastcard;
515 	dreamcastcard = kcontrol->private_data;
516 	if (unlikely(!dreamcastcard->channel))
517 		return -ETXTBSY;	/* we've not yet been set up */
518 	ucontrol->value.integer.value[0] = dreamcastcard->channel->vol;
519 	return 0;
520 }
521 
522 static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
523 			      struct snd_ctl_elem_value *ucontrol)
524 {
525 	struct snd_card_aica *dreamcastcard;
526 	unsigned int vol;
527 	dreamcastcard = kcontrol->private_data;
528 	if (unlikely(!dreamcastcard->channel))
529 		return -ETXTBSY;
530 	vol = ucontrol->value.integer.value[0];
531 	if (vol > 0xff)
532 		return -EINVAL;
533 	if (unlikely(dreamcastcard->channel->vol == vol))
534 		return 0;
535 	dreamcastcard->channel->vol = ucontrol->value.integer.value[0];
536 	dreamcastcard->master_volume = ucontrol->value.integer.value[0];
537 	spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
538 		    dreamcastcard->channel, sizeof(struct aica_channel));
539 	return 1;
540 }
541 
542 static struct snd_kcontrol_new snd_aica_pcmswitch_control __devinitdata = {
543 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
544 	.name = "PCM Playback Switch",
545 	.index = 0,
546 	.info = aica_pcmswitch_info,
547 	.get = aica_pcmswitch_get,
548 	.put = aica_pcmswitch_put
549 };
550 
551 static struct snd_kcontrol_new snd_aica_pcmvolume_control __devinitdata = {
552 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
553 	.name = "PCM Playback Volume",
554 	.index = 0,
555 	.info = aica_pcmvolume_info,
556 	.get = aica_pcmvolume_get,
557 	.put = aica_pcmvolume_put
558 };
559 
560 static int load_aica_firmware(void)
561 {
562 	int err;
563 	const struct firmware *fw_entry;
564 	spu_reset();
565 	err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
566 	if (unlikely(err))
567 		return err;
568 	/* write firware into memory */
569 	spu_disable();
570 	spu_memload(0, fw_entry->data, fw_entry->size);
571 	spu_enable();
572 	release_firmware(fw_entry);
573 	return err;
574 }
575 
576 static int __devinit add_aicamixer_controls(struct snd_card_aica
577 					    *dreamcastcard)
578 {
579 	int err;
580 	err = snd_ctl_add
581 	    (dreamcastcard->card,
582 	     snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
583 	if (unlikely(err < 0))
584 		return err;
585 	err = snd_ctl_add
586 	    (dreamcastcard->card,
587 	     snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
588 	if (unlikely(err < 0))
589 		return err;
590 	return 0;
591 }
592 
593 static int __devexit snd_aica_remove(struct platform_device *devptr)
594 {
595 	struct snd_card_aica *dreamcastcard;
596 	dreamcastcard = platform_get_drvdata(devptr);
597 	if (unlikely(!dreamcastcard))
598 		return -ENODEV;
599 	snd_card_free(dreamcastcard->card);
600 	kfree(dreamcastcard);
601 	platform_set_drvdata(devptr, NULL);
602 	return 0;
603 }
604 
605 static int __devinit snd_aica_probe(struct platform_device *devptr)
606 {
607 	int err;
608 	struct snd_card_aica *dreamcastcard;
609 	dreamcastcard = kmalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
610 	if (unlikely(!dreamcastcard))
611 		return -ENOMEM;
612 	err = snd_card_create(index, SND_AICA_DRIVER, THIS_MODULE, 0,
613 			      &dreamcastcard->card);
614 	if (unlikely(err < 0)) {
615 		kfree(dreamcastcard);
616 		return err;
617 	}
618 	strcpy(dreamcastcard->card->driver, "snd_aica");
619 	strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
620 	strcpy(dreamcastcard->card->longname,
621 	       "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
622 	/* Prepare to use the queue */
623 	INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
624 	/* Load the PCM 'chip' */
625 	err = snd_aicapcmchip(dreamcastcard, 0);
626 	if (unlikely(err < 0))
627 		goto freedreamcast;
628 	snd_card_set_dev(dreamcastcard->card, &devptr->dev);
629 	dreamcastcard->timer.data = 0;
630 	dreamcastcard->channel = NULL;
631 	/* Add basic controls */
632 	err = add_aicamixer_controls(dreamcastcard);
633 	if (unlikely(err < 0))
634 		goto freedreamcast;
635 	/* Register the card with ALSA subsystem */
636 	err = snd_card_register(dreamcastcard->card);
637 	if (unlikely(err < 0))
638 		goto freedreamcast;
639 	platform_set_drvdata(devptr, dreamcastcard);
640 	aica_queue = create_workqueue(CARD_NAME);
641 	if (unlikely(!aica_queue))
642 		goto freedreamcast;
643 	snd_printk
644 	    ("ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
645 	return 0;
646       freedreamcast:
647 	snd_card_free(dreamcastcard->card);
648 	kfree(dreamcastcard);
649 	return err;
650 }
651 
652 static struct platform_driver snd_aica_driver = {
653 	.probe = snd_aica_probe,
654 	.remove = __devexit_p(snd_aica_remove),
655 	.driver = {
656 		   .name = SND_AICA_DRIVER},
657 };
658 
659 static int __init aica_init(void)
660 {
661 	int err;
662 	err = platform_driver_register(&snd_aica_driver);
663 	if (unlikely(err < 0))
664 		return err;
665 	pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
666 					     aica_memory_space, 2);
667 	if (IS_ERR(pd)) {
668 		platform_driver_unregister(&snd_aica_driver);
669 		return PTR_ERR(pd);
670 	}
671 	/* Load the firmware */
672 	return load_aica_firmware();
673 }
674 
675 static void __exit aica_exit(void)
676 {
677 	/* Destroy the aica kernel thread            *
678 	 * being extra cautious to check if it exists*/
679 	if (likely(aica_queue))
680 		destroy_workqueue(aica_queue);
681 	platform_device_unregister(pd);
682 	platform_driver_unregister(&snd_aica_driver);
683 	/* Kill any sound still playing and reset ARM7 to safe state */
684 	spu_reset();
685 }
686 
687 module_init(aica_init);
688 module_exit(aica_exit);
689