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)
109 snd_assert(length % 4 == 0, return);
110 for (i = 0; i < length; i++) {
113 writel(what, toi + SPU_MEMORY_BASE);
118 /* spu_memload - write to SPU address space */
119 static void spu_memload(u32 toi, void *from, int length)
122 u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
125 length = DIV_ROUND_UP(length, 4);
127 for (i = 0; i < length; i++) {
137 /* spu_disable - set spu registers to stop sound output */
138 static void spu_disable(void)
143 regval = readl(ARM_RESET_REGISTER);
146 writel(regval, ARM_RESET_REGISTER);
147 for (i = 0; i < 64; i++) {
149 regval = readl(SPU_REGISTER_BASE + (i * 0x80));
150 regval = (regval & ~0x4000) | 0x8000;
152 writel(regval, SPU_REGISTER_BASE + (i * 0x80));
156 /* spu_enable - set spu registers to enable sound output */
157 static void spu_enable(void)
159 u32 regval = readl(ARM_RESET_REGISTER);
162 writel(regval, ARM_RESET_REGISTER);
166 * Halt the sound processor, clear the memory,
167 * load some default ARM7 code, and then restart ARM7
169 static void spu_reset(void)
172 spu_memset(0, 0, 0x200000 / 4);
173 /* Put ARM7 in endless loop */
174 ctrl_outl(0xea000002, SPU_MEMORY_BASE);
178 /* aica_chn_start - write to spu to start playback */
179 static void aica_chn_start(void)
182 writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
185 /* aica_chn_halt - write to spu to halt playback */
186 static void aica_chn_halt(void)
189 writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
192 /* ALSA code below */
193 static struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
194 .info = (SNDRV_PCM_INFO_NONINTERLEAVED),
196 (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
197 SNDRV_PCM_FMTBIT_IMA_ADPCM),
198 .rates = SNDRV_PCM_RATE_8000_48000,
203 .buffer_bytes_max = AICA_BUFFER_SIZE,
204 .period_bytes_min = AICA_PERIOD_SIZE,
205 .period_bytes_max = AICA_PERIOD_SIZE,
206 .periods_min = AICA_PERIOD_NUMBER,
207 .periods_max = AICA_PERIOD_NUMBER,
210 static int aica_dma_transfer(int channels, int buffer_size,
211 struct snd_pcm_substream *substream)
213 int q, err, period_offset;
214 struct snd_card_aica *dreamcastcard;
215 struct snd_pcm_runtime *runtime;
217 dreamcastcard = substream->pcm->private_data;
218 period_offset = dreamcastcard->clicks;
219 period_offset %= (AICA_PERIOD_NUMBER / channels);
220 runtime = substream->runtime;
221 for (q = 0; q < channels; q++) {
222 err = dma_xfer(AICA_DMA_CHANNEL,
223 (unsigned long) (runtime->dma_area +
224 (AICA_BUFFER_SIZE * q) /
228 AICA_CHANNEL0_OFFSET + q * CHANNEL_OFFSET +
229 AICA_PERIOD_SIZE * period_offset,
230 buffer_size / channels, AICA_DMA_MODE);
231 if (unlikely(err < 0))
233 dma_wait_for_completion(AICA_DMA_CHANNEL);
238 static void startup_aica(struct snd_card_aica *dreamcastcard)
240 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
241 dreamcastcard->channel, sizeof(struct aica_channel));
245 static void run_spu_dma(struct work_struct *work)
248 struct snd_pcm_runtime *runtime;
249 struct snd_card_aica *dreamcastcard;
251 container_of(work, struct snd_card_aica, spu_dma_work);
252 runtime = dreamcastcard->substream->runtime;
253 if (unlikely(dreamcastcard->dma_check == 0)) {
255 frames_to_bytes(runtime, runtime->buffer_size);
256 if (runtime->channels > 1)
257 dreamcastcard->channel->flags |= 0x01;
258 aica_dma_transfer(runtime->channels, buffer_size,
259 dreamcastcard->substream);
260 startup_aica(dreamcastcard);
261 dreamcastcard->clicks =
262 buffer_size / (AICA_PERIOD_SIZE * runtime->channels);
265 aica_dma_transfer(runtime->channels,
266 AICA_PERIOD_SIZE * runtime->channels,
267 dreamcastcard->substream);
268 snd_pcm_period_elapsed(dreamcastcard->substream);
269 dreamcastcard->clicks++;
270 if (unlikely(dreamcastcard->clicks >= AICA_PERIOD_NUMBER))
271 dreamcastcard->clicks %= AICA_PERIOD_NUMBER;
272 mod_timer(&dreamcastcard->timer, jiffies + 1);
276 static void aica_period_elapsed(unsigned long timer_var)
278 /*timer function - so cannot sleep */
280 struct snd_pcm_runtime *runtime;
281 struct snd_pcm_substream *substream;
282 struct snd_card_aica *dreamcastcard;
283 substream = (struct snd_pcm_substream *) timer_var;
284 runtime = substream->runtime;
285 dreamcastcard = substream->pcm->private_data;
286 /* Have we played out an additional period? */
288 frames_to_bytes(runtime,
290 (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
292 if (play_period == dreamcastcard->current_period) {
293 /* reschedule the timer */
294 mod_timer(&(dreamcastcard->timer), jiffies + 1);
297 if (runtime->channels > 1)
298 dreamcastcard->current_period = play_period;
299 if (unlikely(dreamcastcard->dma_check == 0))
300 dreamcastcard->dma_check = 1;
301 queue_work(aica_queue, &(dreamcastcard->spu_dma_work));
304 static void spu_begin_dma(struct snd_pcm_substream *substream)
306 struct snd_card_aica *dreamcastcard;
307 struct snd_pcm_runtime *runtime;
308 runtime = substream->runtime;
309 dreamcastcard = substream->pcm->private_data;
310 /*get the queue to do the work */
311 queue_work(aica_queue, &(dreamcastcard->spu_dma_work));
312 /* Timer may already be running */
313 if (unlikely(dreamcastcard->timer.data)) {
314 mod_timer(&dreamcastcard->timer, jiffies + 4);
317 init_timer(&(dreamcastcard->timer));
318 dreamcastcard->timer.data = (unsigned long) substream;
319 dreamcastcard->timer.function = aica_period_elapsed;
320 dreamcastcard->timer.expires = jiffies + 4;
321 add_timer(&(dreamcastcard->timer));
324 static int snd_aicapcm_pcm_open(struct snd_pcm_substream
327 struct snd_pcm_runtime *runtime;
328 struct aica_channel *channel;
329 struct snd_card_aica *dreamcastcard;
332 dreamcastcard = substream->pcm->private_data;
333 channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
336 /* set defaults for channel */
337 channel->sfmt = SM_8BIT;
338 channel->cmd = AICA_CMD_START;
339 channel->vol = dreamcastcard->master_volume;
342 channel->flags = 0; /* default to mono */
343 dreamcastcard->channel = channel;
344 runtime = substream->runtime;
345 runtime->hw = snd_pcm_aica_playback_hw;
347 dreamcastcard->clicks = 0;
348 dreamcastcard->current_period = 0;
349 dreamcastcard->dma_check = 0;
353 static int snd_aicapcm_pcm_close(struct snd_pcm_substream
356 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
357 flush_workqueue(aica_queue);
358 if (dreamcastcard->timer.data)
359 del_timer(&dreamcastcard->timer);
360 kfree(dreamcastcard->channel);
365 static int snd_aicapcm_pcm_hw_free(struct snd_pcm_substream
368 /* Free the DMA buffer */
369 return snd_pcm_lib_free_pages(substream);
372 static int snd_aicapcm_pcm_hw_params(struct snd_pcm_substream
373 *substream, struct snd_pcm_hw_params
376 /* Allocate a DMA buffer using ALSA built-ins */
378 snd_pcm_lib_malloc_pages(substream,
379 params_buffer_bytes(hw_params));
382 static int snd_aicapcm_pcm_prepare(struct snd_pcm_substream
385 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
386 if ((substream->runtime)->format == SNDRV_PCM_FORMAT_S16_LE)
387 dreamcastcard->channel->sfmt = SM_16BIT;
388 dreamcastcard->channel->freq = substream->runtime->rate;
389 dreamcastcard->substream = substream;
393 static int snd_aicapcm_pcm_trigger(struct snd_pcm_substream
397 case SNDRV_PCM_TRIGGER_START:
398 spu_begin_dma(substream);
400 case SNDRV_PCM_TRIGGER_STOP:
409 static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream
412 return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER);
415 static struct snd_pcm_ops snd_aicapcm_playback_ops = {
416 .open = snd_aicapcm_pcm_open,
417 .close = snd_aicapcm_pcm_close,
418 .ioctl = snd_pcm_lib_ioctl,
419 .hw_params = snd_aicapcm_pcm_hw_params,
420 .hw_free = snd_aicapcm_pcm_hw_free,
421 .prepare = snd_aicapcm_pcm_prepare,
422 .trigger = snd_aicapcm_pcm_trigger,
423 .pointer = snd_aicapcm_pcm_pointer,
426 /* TO DO: set up to handle more than one pcm instance */
427 static int __init snd_aicapcmchip(struct snd_card_aica
428 *dreamcastcard, int pcm_index)
432 /* AICA has no capture ability */
434 snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
436 if (unlikely(err < 0))
438 pcm->private_data = dreamcastcard;
439 strcpy(pcm->name, "AICA PCM");
440 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
441 &snd_aicapcm_playback_ops);
442 /* Allocate the DMA buffers */
444 snd_pcm_lib_preallocate_pages_for_all(pcm,
445 SNDRV_DMA_TYPE_CONTINUOUS,
446 snd_dma_continuous_data
454 #define aica_pcmswitch_info snd_ctl_boolean_mono_info
456 static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
457 struct snd_ctl_elem_value *ucontrol)
459 ucontrol->value.integer.value[0] = 1; /* TO DO: Fix me */
463 static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
464 struct snd_ctl_elem_value *ucontrol)
466 if (ucontrol->value.integer.value[0] == 1)
467 return 0; /* TO DO: Fix me */
473 static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
474 struct snd_ctl_elem_info *uinfo)
476 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
478 uinfo->value.integer.min = 0;
479 uinfo->value.integer.max = 0xFF;
483 static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
484 struct snd_ctl_elem_value *ucontrol)
486 struct snd_card_aica *dreamcastcard;
487 dreamcastcard = kcontrol->private_data;
488 if (unlikely(!dreamcastcard->channel))
489 return -ETXTBSY; /* we've not yet been set up */
490 ucontrol->value.integer.value[0] = dreamcastcard->channel->vol;
494 static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
495 struct snd_ctl_elem_value *ucontrol)
497 struct snd_card_aica *dreamcastcard;
498 dreamcastcard = kcontrol->private_data;
499 if (unlikely(!dreamcastcard->channel))
501 if (unlikely(dreamcastcard->channel->vol ==
502 ucontrol->value.integer.value[0]))
504 dreamcastcard->channel->vol = ucontrol->value.integer.value[0];
505 dreamcastcard->master_volume = ucontrol->value.integer.value[0];
506 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
507 dreamcastcard->channel, sizeof(struct aica_channel));
511 static struct snd_kcontrol_new snd_aica_pcmswitch_control __devinitdata = {
512 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
513 .name = "PCM Playback Switch",
515 .info = aica_pcmswitch_info,
516 .get = aica_pcmswitch_get,
517 .put = aica_pcmswitch_put
520 static struct snd_kcontrol_new snd_aica_pcmvolume_control __devinitdata = {
521 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
522 .name = "PCM Playback Volume",
524 .info = aica_pcmvolume_info,
525 .get = aica_pcmvolume_get,
526 .put = aica_pcmvolume_put
529 static int load_aica_firmware(void)
532 const struct firmware *fw_entry;
534 err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
537 /* write firware into memory */
539 spu_memload(0, fw_entry->data, fw_entry->size);
541 release_firmware(fw_entry);
545 static int __devinit add_aicamixer_controls(struct snd_card_aica
550 (dreamcastcard->card,
551 snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
552 if (unlikely(err < 0))
555 (dreamcastcard->card,
556 snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
557 if (unlikely(err < 0))
562 static int snd_aica_remove(struct platform_device *devptr)
564 struct snd_card_aica *dreamcastcard;
565 dreamcastcard = platform_get_drvdata(devptr);
566 if (unlikely(!dreamcastcard))
568 snd_card_free(dreamcastcard->card);
569 kfree(dreamcastcard);
570 platform_set_drvdata(devptr, NULL);
574 static int __init snd_aica_probe(struct platform_device *devptr)
577 struct snd_card_aica *dreamcastcard;
578 dreamcastcard = kmalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
579 if (unlikely(!dreamcastcard))
581 dreamcastcard->card =
582 snd_card_new(index, SND_AICA_DRIVER, THIS_MODULE, 0);
583 if (unlikely(!dreamcastcard->card)) {
584 kfree(dreamcastcard);
587 strcpy(dreamcastcard->card->driver, "snd_aica");
588 strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
589 strcpy(dreamcastcard->card->longname,
590 "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
591 /* Prepare to use the queue */
592 INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
593 /* Load the PCM 'chip' */
594 err = snd_aicapcmchip(dreamcastcard, 0);
595 if (unlikely(err < 0))
597 snd_card_set_dev(dreamcastcard->card, &devptr->dev);
598 dreamcastcard->timer.data = 0;
599 dreamcastcard->channel = NULL;
600 /* Add basic controls */
601 err = add_aicamixer_controls(dreamcastcard);
602 if (unlikely(err < 0))
604 /* Register the card with ALSA subsystem */
605 err = snd_card_register(dreamcastcard->card);
606 if (unlikely(err < 0))
608 platform_set_drvdata(devptr, dreamcastcard);
609 aica_queue = create_workqueue(CARD_NAME);
610 if (unlikely(!aica_queue))
613 ("ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
616 snd_card_free(dreamcastcard->card);
617 kfree(dreamcastcard);
621 static struct platform_driver snd_aica_driver = {
622 .probe = snd_aica_probe,
623 .remove = snd_aica_remove,
625 .name = SND_AICA_DRIVER},
628 static int __init aica_init(void)
631 err = platform_driver_register(&snd_aica_driver);
632 if (unlikely(err < 0))
634 pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
635 aica_memory_space, 2);
636 if (unlikely(IS_ERR(pd))) {
637 platform_driver_unregister(&snd_aica_driver);
640 /* Load the firmware */
641 return load_aica_firmware();
644 static void __exit aica_exit(void)
646 /* Destroy the aica kernel thread *
647 * being extra cautious to check if it exists*/
648 if (likely(aica_queue))
649 destroy_workqueue(aica_queue);
650 platform_device_unregister(pd);
651 platform_driver_unregister(&snd_aica_driver);
652 /* Kill any sound still playing and reset ARM7 to safe state */
656 module_init(aica_init);
657 module_exit(aica_exit);