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/module.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>
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>
45 #include <mach/sysasic.h>
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 MODULE_FIRMWARE("aica_firmware.bin");
54 /* module parameters */
55 #define CARD_NAME "AICA"
56 static int index = -1;
58 static bool 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.");
66 /* Simple platform device */
67 static struct platform_device *pd;
68 static struct resource aica_memory_space[2] = {
70 .name = "AICA ARM CONTROL",
71 .start = ARM_RESET_REGISTER,
72 .flags = IORESOURCE_MEM,
73 .end = ARM_RESET_REGISTER + 3,
76 .name = "AICA Sound RAM",
77 .start = SPU_MEMORY_BASE,
78 .flags = IORESOURCE_MEM,
79 .end = SPU_MEMORY_BASE + 0x200000 - 1,
83 /* SPU specific functions */
84 /* spu_write_wait - wait for G2-SH FIFO to clear */
85 static void spu_write_wait(void)
90 if (!(readl(G2_FIFO) & 0x11))
92 /* To ensure hardware failure doesn't wedge kernel */
94 if (time_count > 0x10000) {
96 ("WARNING: G2 FIFO appears to be blocked.\n");
102 /* spu_memset - write to memory in SPU address space */
103 static void spu_memset(u32 toi, u32 what, int length)
107 if (snd_BUG_ON(length % 4))
109 for (i = 0; i < length; i++) {
112 local_irq_save(flags);
113 writel(what, toi + SPU_MEMORY_BASE);
114 local_irq_restore(flags);
119 /* spu_memload - write to SPU address space */
120 static void spu_memload(u32 toi, const void *from, int length)
123 const u32 *froml = from;
124 u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
127 length = DIV_ROUND_UP(length, 4);
129 for (i = 0; i < length; i++) {
133 local_irq_save(flags);
135 local_irq_restore(flags);
141 /* spu_disable - set spu registers to stop sound output */
142 static void spu_disable(void)
148 regval = readl(ARM_RESET_REGISTER);
151 local_irq_save(flags);
152 writel(regval, ARM_RESET_REGISTER);
153 local_irq_restore(flags);
154 for (i = 0; i < 64; i++) {
156 regval = readl(SPU_REGISTER_BASE + (i * 0x80));
157 regval = (regval & ~0x4000) | 0x8000;
159 local_irq_save(flags);
160 writel(regval, SPU_REGISTER_BASE + (i * 0x80));
161 local_irq_restore(flags);
165 /* spu_enable - set spu registers to enable sound output */
166 static void spu_enable(void)
169 u32 regval = readl(ARM_RESET_REGISTER);
172 local_irq_save(flags);
173 writel(regval, ARM_RESET_REGISTER);
174 local_irq_restore(flags);
178 * Halt the sound processor, clear the memory,
179 * load some default ARM7 code, and then restart ARM7
181 static void spu_reset(void)
185 spu_memset(0, 0, 0x200000 / 4);
186 /* Put ARM7 in endless loop */
187 local_irq_save(flags);
188 __raw_writel(0xea000002, SPU_MEMORY_BASE);
189 local_irq_restore(flags);
193 /* aica_chn_start - write to spu to start playback */
194 static void aica_chn_start(void)
198 local_irq_save(flags);
199 writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
200 local_irq_restore(flags);
203 /* aica_chn_halt - write to spu to halt playback */
204 static void aica_chn_halt(void)
208 local_irq_save(flags);
209 writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
210 local_irq_restore(flags);
213 /* ALSA code below */
214 static const struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
215 .info = (SNDRV_PCM_INFO_NONINTERLEAVED),
217 (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
218 SNDRV_PCM_FMTBIT_IMA_ADPCM),
219 .rates = SNDRV_PCM_RATE_8000_48000,
224 .buffer_bytes_max = AICA_BUFFER_SIZE,
225 .period_bytes_min = AICA_PERIOD_SIZE,
226 .period_bytes_max = AICA_PERIOD_SIZE,
227 .periods_min = AICA_PERIOD_NUMBER,
228 .periods_max = AICA_PERIOD_NUMBER,
231 static int aica_dma_transfer(int channels, int buffer_size,
232 struct snd_pcm_substream *substream)
234 int q, err, period_offset;
235 struct snd_card_aica *dreamcastcard;
236 struct snd_pcm_runtime *runtime;
239 dreamcastcard = substream->pcm->private_data;
240 period_offset = dreamcastcard->clicks;
241 period_offset %= (AICA_PERIOD_NUMBER / channels);
242 runtime = substream->runtime;
243 for (q = 0; q < channels; q++) {
244 local_irq_save(flags);
245 err = dma_xfer(AICA_DMA_CHANNEL,
246 (unsigned long) (runtime->dma_area +
247 (AICA_BUFFER_SIZE * q) /
251 AICA_CHANNEL0_OFFSET + q * CHANNEL_OFFSET +
252 AICA_PERIOD_SIZE * period_offset,
253 buffer_size / channels, AICA_DMA_MODE);
254 if (unlikely(err < 0)) {
255 local_irq_restore(flags);
258 dma_wait_for_completion(AICA_DMA_CHANNEL);
259 local_irq_restore(flags);
264 static void startup_aica(struct snd_card_aica *dreamcastcard)
266 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
267 dreamcastcard->channel, sizeof(struct aica_channel));
271 static void run_spu_dma(struct work_struct *work)
274 struct snd_pcm_runtime *runtime;
275 struct snd_card_aica *dreamcastcard;
277 container_of(work, struct snd_card_aica, spu_dma_work);
278 runtime = dreamcastcard->substream->runtime;
279 if (unlikely(dreamcastcard->dma_check == 0)) {
281 frames_to_bytes(runtime, runtime->buffer_size);
282 if (runtime->channels > 1)
283 dreamcastcard->channel->flags |= 0x01;
284 aica_dma_transfer(runtime->channels, buffer_size,
285 dreamcastcard->substream);
286 startup_aica(dreamcastcard);
287 dreamcastcard->clicks =
288 buffer_size / (AICA_PERIOD_SIZE * runtime->channels);
291 aica_dma_transfer(runtime->channels,
292 AICA_PERIOD_SIZE * runtime->channels,
293 dreamcastcard->substream);
294 snd_pcm_period_elapsed(dreamcastcard->substream);
295 dreamcastcard->clicks++;
296 if (unlikely(dreamcastcard->clicks >= AICA_PERIOD_NUMBER))
297 dreamcastcard->clicks %= AICA_PERIOD_NUMBER;
298 if (snd_pcm_running(dreamcastcard->substream))
299 mod_timer(&dreamcastcard->timer, jiffies + 1);
303 static void aica_period_elapsed(struct timer_list *t)
305 struct snd_card_aica *dreamcastcard = from_timer(dreamcastcard,
307 struct snd_pcm_substream *substream = dreamcastcard->substream;
308 /*timer function - so cannot sleep */
310 struct snd_pcm_runtime *runtime;
311 if (!snd_pcm_running(substream))
313 runtime = substream->runtime;
314 dreamcastcard = substream->pcm->private_data;
315 /* Have we played out an additional period? */
317 frames_to_bytes(runtime,
319 (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
321 if (play_period == dreamcastcard->current_period) {
322 /* reschedule the timer */
323 mod_timer(&(dreamcastcard->timer), jiffies + 1);
326 if (runtime->channels > 1)
327 dreamcastcard->current_period = play_period;
328 if (unlikely(dreamcastcard->dma_check == 0))
329 dreamcastcard->dma_check = 1;
330 schedule_work(&(dreamcastcard->spu_dma_work));
333 static void spu_begin_dma(struct snd_pcm_substream *substream)
335 struct snd_card_aica *dreamcastcard;
336 struct snd_pcm_runtime *runtime;
337 runtime = substream->runtime;
338 dreamcastcard = substream->pcm->private_data;
339 /*get the queue to do the work */
340 schedule_work(&(dreamcastcard->spu_dma_work));
341 mod_timer(&dreamcastcard->timer, jiffies + 4);
344 static int snd_aicapcm_pcm_open(struct snd_pcm_substream
347 struct snd_pcm_runtime *runtime;
348 struct aica_channel *channel;
349 struct snd_card_aica *dreamcastcard;
352 dreamcastcard = substream->pcm->private_data;
353 channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
356 /* set defaults for channel */
357 channel->sfmt = SM_8BIT;
358 channel->cmd = AICA_CMD_START;
359 channel->vol = dreamcastcard->master_volume;
362 channel->flags = 0; /* default to mono */
363 dreamcastcard->channel = channel;
364 runtime = substream->runtime;
365 runtime->hw = snd_pcm_aica_playback_hw;
367 dreamcastcard->clicks = 0;
368 dreamcastcard->current_period = 0;
369 dreamcastcard->dma_check = 0;
373 static int snd_aicapcm_pcm_sync_stop(struct snd_pcm_substream *substream)
375 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
377 del_timer_sync(&dreamcastcard->timer);
378 cancel_work_sync(&dreamcastcard->spu_dma_work);
382 static int snd_aicapcm_pcm_close(struct snd_pcm_substream
385 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
386 dreamcastcard->substream = NULL;
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 const 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,
451 .sync_stop = snd_aicapcm_pcm_sync_stop,
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)
460 /* AICA has no capture ability */
462 snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
464 if (unlikely(err < 0))
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 */
472 snd_pcm_lib_preallocate_pages_for_all(pcm,
473 SNDRV_DMA_TYPE_CONTINUOUS,
474 snd_dma_continuous_data
482 #define aica_pcmswitch_info snd_ctl_boolean_mono_info
484 static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
485 struct snd_ctl_elem_value *ucontrol)
487 ucontrol->value.integer.value[0] = 1; /* TO DO: Fix me */
491 static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
492 struct snd_ctl_elem_value *ucontrol)
494 if (ucontrol->value.integer.value[0] == 1)
495 return 0; /* TO DO: Fix me */
501 static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
502 struct snd_ctl_elem_info *uinfo)
504 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
506 uinfo->value.integer.min = 0;
507 uinfo->value.integer.max = 0xFF;
511 static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
512 struct snd_ctl_elem_value *ucontrol)
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;
522 static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
523 struct snd_ctl_elem_value *ucontrol)
525 struct snd_card_aica *dreamcastcard;
527 dreamcastcard = kcontrol->private_data;
528 if (unlikely(!dreamcastcard->channel))
530 vol = ucontrol->value.integer.value[0];
533 if (unlikely(dreamcastcard->channel->vol == vol))
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));
542 static const struct snd_kcontrol_new snd_aica_pcmswitch_control = {
543 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
544 .name = "PCM Playback Switch",
546 .info = aica_pcmswitch_info,
547 .get = aica_pcmswitch_get,
548 .put = aica_pcmswitch_put
551 static const struct snd_kcontrol_new snd_aica_pcmvolume_control = {
552 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
553 .name = "PCM Playback Volume",
555 .info = aica_pcmvolume_info,
556 .get = aica_pcmvolume_get,
557 .put = aica_pcmvolume_put
560 static int load_aica_firmware(void)
563 const struct firmware *fw_entry;
565 err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
568 /* write firmware into memory */
570 spu_memload(0, fw_entry->data, fw_entry->size);
572 release_firmware(fw_entry);
576 static int add_aicamixer_controls(struct snd_card_aica *dreamcastcard)
580 (dreamcastcard->card,
581 snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
582 if (unlikely(err < 0))
585 (dreamcastcard->card,
586 snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
587 if (unlikely(err < 0))
592 static int snd_aica_remove(struct platform_device *devptr)
594 struct snd_card_aica *dreamcastcard;
595 dreamcastcard = platform_get_drvdata(devptr);
596 if (unlikely(!dreamcastcard))
598 snd_card_free(dreamcastcard->card);
599 kfree(dreamcastcard);
603 static int snd_aica_probe(struct platform_device *devptr)
606 struct snd_card_aica *dreamcastcard;
607 dreamcastcard = kzalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
608 if (unlikely(!dreamcastcard))
610 err = snd_card_new(&devptr->dev, index, SND_AICA_DRIVER,
611 THIS_MODULE, 0, &dreamcastcard->card);
612 if (unlikely(err < 0)) {
613 kfree(dreamcastcard);
616 strcpy(dreamcastcard->card->driver, "snd_aica");
617 strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
618 strcpy(dreamcastcard->card->longname,
619 "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
620 /* Prepare to use the queue */
621 INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
622 timer_setup(&dreamcastcard->timer, aica_period_elapsed, 0);
623 /* Load the PCM 'chip' */
624 err = snd_aicapcmchip(dreamcastcard, 0);
625 if (unlikely(err < 0))
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);
637 ("ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
640 snd_card_free(dreamcastcard->card);
641 kfree(dreamcastcard);
645 static struct platform_driver snd_aica_driver = {
646 .probe = snd_aica_probe,
647 .remove = snd_aica_remove,
649 .name = SND_AICA_DRIVER,
653 static int __init aica_init(void)
656 err = platform_driver_register(&snd_aica_driver);
657 if (unlikely(err < 0))
659 pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
660 aica_memory_space, 2);
662 platform_driver_unregister(&snd_aica_driver);
665 /* Load the firmware */
666 return load_aica_firmware();
669 static void __exit aica_exit(void)
671 platform_device_unregister(pd);
672 platform_driver_unregister(&snd_aica_driver);
673 /* Kill any sound still playing and reset ARM7 to safe state */
677 module_init(aica_init);
678 module_exit(aica_exit);