2 * This code is licenced under
3 * the General Public Licence
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/
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.
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.
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
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/driver.h>
39 #include <sound/core.h>
40 #include <sound/control.h>
41 #include <sound/pcm.h>
42 #include <sound/initval.h>
43 #include <sound/info.h>
46 #include <asm/dreamcast/sysasic.h>
49 MODULE_AUTHOR("Adrian McMenamin <adrian@mcmen.demon.co.uk>");
50 MODULE_DESCRIPTION("Dreamcast AICA sound (pcm) driver");
51 MODULE_LICENSE("GPL");
52 MODULE_SUPPORTED_DEVICE("{{Yamaha/SEGA, AICA}}");
54 /* module parameters */
55 #define CARD_NAME "AICA"
56 static int index = -1;
58 static int enable = 1;
59 module_param(index, int, 0444);
60 MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard.");
61 module_param(id, charp, 0444);
62 MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard.");
63 module_param(enable, bool, 0644);
64 MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard.");
67 static struct workqueue_struct *aica_queue;
69 /* Simple platform device */
70 static struct platform_device *pd;
71 static struct resource aica_memory_space[2] = {
73 .name = "AICA ARM CONTROL",
74 .start = ARM_RESET_REGISTER,
75 .flags = IORESOURCE_MEM,
76 .end = ARM_RESET_REGISTER + 3,
79 .name = "AICA Sound RAM",
80 .start = SPU_MEMORY_BASE,
81 .flags = IORESOURCE_MEM,
82 .end = SPU_MEMORY_BASE + 0x200000 - 1,
86 /* SPU specific functions */
87 /* spu_write_wait - wait for G2-SH FIFO to clear */
88 static void spu_write_wait(void)
93 if (!(readl(G2_FIFO) & 0x11))
95 /* To ensure hardware failure doesn't wedge kernel */
97 if (time_count > 0x10000) {
99 ("WARNING: G2 FIFO appears to be blocked.\n");
105 /* spu_memset - write to memory in SPU address space */
106 static void spu_memset(u32 toi, u32 what, int length)
110 snd_assert(length % 4 == 0, return);
111 for (i = 0; i < length; i++) {
114 local_irq_save(flags);
115 writel(what, toi + SPU_MEMORY_BASE);
116 local_irq_restore(flags);
121 /* spu_memload - write to SPU address space */
122 static void spu_memload(u32 toi, void *from, int length)
126 u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
129 length = DIV_ROUND_UP(length, 4);
131 for (i = 0; i < length; i++) {
135 local_irq_save(flags);
137 local_irq_restore(flags);
143 /* spu_disable - set spu registers to stop sound output */
144 static void spu_disable(void)
150 regval = readl(ARM_RESET_REGISTER);
153 local_irq_save(flags);
154 writel(regval, ARM_RESET_REGISTER);
155 local_irq_restore(flags);
156 for (i = 0; i < 64; i++) {
158 regval = readl(SPU_REGISTER_BASE + (i * 0x80));
159 regval = (regval & ~0x4000) | 0x8000;
161 local_irq_save(flags);
162 writel(regval, SPU_REGISTER_BASE + (i * 0x80));
163 local_irq_restore(flags);
167 /* spu_enable - set spu registers to enable sound output */
168 static void spu_enable(void)
171 u32 regval = readl(ARM_RESET_REGISTER);
174 local_irq_save(flags);
175 writel(regval, ARM_RESET_REGISTER);
176 local_irq_restore(flags);
180 * Halt the sound processor, clear the memory,
181 * load some default ARM7 code, and then restart ARM7
183 static void spu_reset(void)
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);
195 /* aica_chn_start - write to spu to start playback */
196 static void aica_chn_start(void)
200 local_irq_save(flags);
201 writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
202 local_irq_restore(flags);
205 /* aica_chn_halt - write to spu to halt playback */
206 static void aica_chn_halt(void)
210 local_irq_save(flags);
211 writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
212 local_irq_restore(flags);
215 /* ALSA code below */
216 static struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
217 .info = (SNDRV_PCM_INFO_NONINTERLEAVED),
219 (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
220 SNDRV_PCM_FMTBIT_IMA_ADPCM),
221 .rates = SNDRV_PCM_RATE_8000_48000,
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,
233 static int aica_dma_transfer(int channels, int buffer_size,
234 struct snd_pcm_substream *substream)
236 int q, err, period_offset;
237 struct snd_card_aica *dreamcastcard;
238 struct snd_pcm_runtime *runtime;
240 dreamcastcard = substream->pcm->private_data;
241 period_offset = dreamcastcard->clicks;
242 period_offset %= (AICA_PERIOD_NUMBER / channels);
243 runtime = substream->runtime;
244 for (q = 0; q < channels; q++) {
245 local_irq_save(flags);
246 err = dma_xfer(AICA_DMA_CHANNEL,
247 (unsigned long) (runtime->dma_area +
248 (AICA_BUFFER_SIZE * q) /
252 AICA_CHANNEL0_OFFSET + q * CHANNEL_OFFSET +
253 AICA_PERIOD_SIZE * period_offset,
254 buffer_size / channels, AICA_DMA_MODE);
255 if (unlikely(err < 0)) {
256 local_irq_restore(flags);
259 dma_wait_for_completion(AICA_DMA_CHANNEL);
260 local_irq_restore(flags);
265 static void startup_aica(struct snd_card_aica *dreamcastcard)
267 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
268 dreamcastcard->channel, sizeof(struct aica_channel));
272 static void run_spu_dma(struct work_struct *work)
275 struct snd_pcm_runtime *runtime;
276 struct snd_card_aica *dreamcastcard;
278 container_of(work, struct snd_card_aica, spu_dma_work);
279 runtime = dreamcastcard->substream->runtime;
280 if (unlikely(dreamcastcard->dma_check == 0)) {
282 frames_to_bytes(runtime, runtime->buffer_size);
283 if (runtime->channels > 1)
284 dreamcastcard->channel->flags |= 0x01;
285 aica_dma_transfer(runtime->channels, buffer_size,
286 dreamcastcard->substream);
287 startup_aica(dreamcastcard);
288 dreamcastcard->clicks =
289 buffer_size / (AICA_PERIOD_SIZE * runtime->channels);
292 aica_dma_transfer(runtime->channels,
293 AICA_PERIOD_SIZE * runtime->channels,
294 dreamcastcard->substream);
295 snd_pcm_period_elapsed(dreamcastcard->substream);
296 dreamcastcard->clicks++;
297 if (unlikely(dreamcastcard->clicks >= AICA_PERIOD_NUMBER))
298 dreamcastcard->clicks %= AICA_PERIOD_NUMBER;
299 mod_timer(&dreamcastcard->timer, jiffies + 1);
303 static void aica_period_elapsed(unsigned long timer_var)
305 /*timer function - so cannot sleep */
307 struct snd_pcm_runtime *runtime;
308 struct snd_pcm_substream *substream;
309 struct snd_card_aica *dreamcastcard;
310 substream = (struct snd_pcm_substream *) timer_var;
311 runtime = substream->runtime;
312 dreamcastcard = substream->pcm->private_data;
313 /* Have we played out an additional period? */
315 frames_to_bytes(runtime,
317 (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
319 if (play_period == dreamcastcard->current_period) {
320 /* reschedule the timer */
321 mod_timer(&(dreamcastcard->timer), jiffies + 1);
324 if (runtime->channels > 1)
325 dreamcastcard->current_period = play_period;
326 if (unlikely(dreamcastcard->dma_check == 0))
327 dreamcastcard->dma_check = 1;
328 queue_work(aica_queue, &(dreamcastcard->spu_dma_work));
331 static void spu_begin_dma(struct snd_pcm_substream *substream)
333 struct snd_card_aica *dreamcastcard;
334 struct snd_pcm_runtime *runtime;
335 runtime = substream->runtime;
336 dreamcastcard = substream->pcm->private_data;
337 /*get the queue to do the work */
338 queue_work(aica_queue, &(dreamcastcard->spu_dma_work));
339 /* Timer may already be running */
340 if (unlikely(dreamcastcard->timer.data)) {
341 mod_timer(&dreamcastcard->timer, jiffies + 4);
344 init_timer(&(dreamcastcard->timer));
345 dreamcastcard->timer.data = (unsigned long) substream;
346 dreamcastcard->timer.function = aica_period_elapsed;
347 dreamcastcard->timer.expires = jiffies + 4;
348 add_timer(&(dreamcastcard->timer));
351 static int snd_aicapcm_pcm_open(struct snd_pcm_substream
354 struct snd_pcm_runtime *runtime;
355 struct aica_channel *channel;
356 struct snd_card_aica *dreamcastcard;
359 dreamcastcard = substream->pcm->private_data;
360 channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
363 /* set defaults for channel */
364 channel->sfmt = SM_8BIT;
365 channel->cmd = AICA_CMD_START;
366 channel->vol = dreamcastcard->master_volume;
369 channel->flags = 0; /* default to mono */
370 dreamcastcard->channel = channel;
371 runtime = substream->runtime;
372 runtime->hw = snd_pcm_aica_playback_hw;
374 dreamcastcard->clicks = 0;
375 dreamcastcard->current_period = 0;
376 dreamcastcard->dma_check = 0;
380 static int snd_aicapcm_pcm_close(struct snd_pcm_substream
383 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
384 flush_workqueue(aica_queue);
385 if (dreamcastcard->timer.data)
386 del_timer(&dreamcastcard->timer);
387 kfree(dreamcastcard->channel);
392 static int snd_aicapcm_pcm_hw_free(struct snd_pcm_substream
395 /* Free the DMA buffer */
396 return snd_pcm_lib_free_pages(substream);
399 static int snd_aicapcm_pcm_hw_params(struct snd_pcm_substream
400 *substream, struct snd_pcm_hw_params
403 /* Allocate a DMA buffer using ALSA built-ins */
405 snd_pcm_lib_malloc_pages(substream,
406 params_buffer_bytes(hw_params));
409 static int snd_aicapcm_pcm_prepare(struct snd_pcm_substream
412 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
413 if ((substream->runtime)->format == SNDRV_PCM_FORMAT_S16_LE)
414 dreamcastcard->channel->sfmt = SM_16BIT;
415 dreamcastcard->channel->freq = substream->runtime->rate;
416 dreamcastcard->substream = substream;
420 static int snd_aicapcm_pcm_trigger(struct snd_pcm_substream
424 case SNDRV_PCM_TRIGGER_START:
425 spu_begin_dma(substream);
427 case SNDRV_PCM_TRIGGER_STOP:
436 static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream
439 return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER);
442 static struct snd_pcm_ops snd_aicapcm_playback_ops = {
443 .open = snd_aicapcm_pcm_open,
444 .close = snd_aicapcm_pcm_close,
445 .ioctl = snd_pcm_lib_ioctl,
446 .hw_params = snd_aicapcm_pcm_hw_params,
447 .hw_free = snd_aicapcm_pcm_hw_free,
448 .prepare = snd_aicapcm_pcm_prepare,
449 .trigger = snd_aicapcm_pcm_trigger,
450 .pointer = snd_aicapcm_pcm_pointer,
453 /* TO DO: set up to handle more than one pcm instance */
454 static int __init snd_aicapcmchip(struct snd_card_aica
455 *dreamcastcard, int pcm_index)
459 /* AICA has no capture ability */
461 snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
463 if (unlikely(err < 0))
465 pcm->private_data = dreamcastcard;
466 strcpy(pcm->name, "AICA PCM");
467 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
468 &snd_aicapcm_playback_ops);
469 /* Allocate the DMA buffers */
471 snd_pcm_lib_preallocate_pages_for_all(pcm,
472 SNDRV_DMA_TYPE_CONTINUOUS,
473 snd_dma_continuous_data
481 #define aica_pcmswitch_info snd_ctl_boolean_mono_info
483 static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
484 struct snd_ctl_elem_value *ucontrol)
486 ucontrol->value.integer.value[0] = 1; /* TO DO: Fix me */
490 static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
491 struct snd_ctl_elem_value *ucontrol)
493 if (ucontrol->value.integer.value[0] == 1)
494 return 0; /* TO DO: Fix me */
500 static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
501 struct snd_ctl_elem_info *uinfo)
503 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
505 uinfo->value.integer.min = 0;
506 uinfo->value.integer.max = 0xFF;
510 static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
511 struct snd_ctl_elem_value *ucontrol)
513 struct snd_card_aica *dreamcastcard;
514 dreamcastcard = kcontrol->private_data;
515 if (unlikely(!dreamcastcard->channel))
516 return -ETXTBSY; /* we've not yet been set up */
517 ucontrol->value.integer.value[0] = dreamcastcard->channel->vol;
521 static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
522 struct snd_ctl_elem_value *ucontrol)
524 struct snd_card_aica *dreamcastcard;
525 dreamcastcard = kcontrol->private_data;
526 if (unlikely(!dreamcastcard->channel))
528 if (unlikely(dreamcastcard->channel->vol ==
529 ucontrol->value.integer.value[0]))
531 dreamcastcard->channel->vol = ucontrol->value.integer.value[0];
532 dreamcastcard->master_volume = ucontrol->value.integer.value[0];
533 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
534 dreamcastcard->channel, sizeof(struct aica_channel));
538 static struct snd_kcontrol_new snd_aica_pcmswitch_control __devinitdata = {
539 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
540 .name = "PCM Playback Switch",
542 .info = aica_pcmswitch_info,
543 .get = aica_pcmswitch_get,
544 .put = aica_pcmswitch_put
547 static struct snd_kcontrol_new snd_aica_pcmvolume_control __devinitdata = {
548 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
549 .name = "PCM Playback Volume",
551 .info = aica_pcmvolume_info,
552 .get = aica_pcmvolume_get,
553 .put = aica_pcmvolume_put
556 static int load_aica_firmware(void)
559 const struct firmware *fw_entry;
561 err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
564 /* write firware into memory */
566 spu_memload(0, fw_entry->data, fw_entry->size);
568 release_firmware(fw_entry);
572 static int __devinit add_aicamixer_controls(struct snd_card_aica
577 (dreamcastcard->card,
578 snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
579 if (unlikely(err < 0))
582 (dreamcastcard->card,
583 snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
584 if (unlikely(err < 0))
589 static int snd_aica_remove(struct platform_device *devptr)
591 struct snd_card_aica *dreamcastcard;
592 dreamcastcard = platform_get_drvdata(devptr);
593 if (unlikely(!dreamcastcard))
595 snd_card_free(dreamcastcard->card);
596 kfree(dreamcastcard);
597 platform_set_drvdata(devptr, NULL);
601 static int __init snd_aica_probe(struct platform_device *devptr)
604 struct snd_card_aica *dreamcastcard;
605 dreamcastcard = kmalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
606 if (unlikely(!dreamcastcard))
608 dreamcastcard->card =
609 snd_card_new(index, SND_AICA_DRIVER, THIS_MODULE, 0);
610 if (unlikely(!dreamcastcard->card)) {
611 kfree(dreamcastcard);
614 strcpy(dreamcastcard->card->driver, "snd_aica");
615 strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
616 strcpy(dreamcastcard->card->longname,
617 "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
618 /* Prepare to use the queue */
619 INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
620 /* Load the PCM 'chip' */
621 err = snd_aicapcmchip(dreamcastcard, 0);
622 if (unlikely(err < 0))
624 snd_card_set_dev(dreamcastcard->card, &devptr->dev);
625 dreamcastcard->timer.data = 0;
626 dreamcastcard->channel = NULL;
627 /* Add basic controls */
628 err = add_aicamixer_controls(dreamcastcard);
629 if (unlikely(err < 0))
631 /* Register the card with ALSA subsystem */
632 err = snd_card_register(dreamcastcard->card);
633 if (unlikely(err < 0))
635 platform_set_drvdata(devptr, dreamcastcard);
636 aica_queue = create_workqueue(CARD_NAME);
637 if (unlikely(!aica_queue))
640 ("ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
643 snd_card_free(dreamcastcard->card);
644 kfree(dreamcastcard);
648 static struct platform_driver snd_aica_driver = {
649 .probe = snd_aica_probe,
650 .remove = snd_aica_remove,
652 .name = SND_AICA_DRIVER},
655 static int __init aica_init(void)
658 err = platform_driver_register(&snd_aica_driver);
659 if (unlikely(err < 0))
661 pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
662 aica_memory_space, 2);
663 if (unlikely(IS_ERR(pd))) {
664 platform_driver_unregister(&snd_aica_driver);
667 /* Load the firmware */
668 return load_aica_firmware();
671 static void __exit aica_exit(void)
673 /* Destroy the aica kernel thread *
674 * being extra cautious to check if it exists*/
675 if (likely(aica_queue))
676 destroy_workqueue(aica_queue);
677 platform_device_unregister(pd);
678 platform_driver_unregister(&snd_aica_driver);
679 /* Kill any sound still playing and reset ARM7 to safe state */
683 module_init(aica_init);
684 module_exit(aica_exit);