1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright Adrian McMenamin 2005, 2006, 2007
5 * <adrian@mcmen.demon.co.uk>
6 * Requires firmware (BSD licenced) available from:
7 * http://linuxdc.cvs.sourceforge.net/linuxdc/linux-sh-dc/sound/oss/aica/firmware/
11 #include <linux/init.h>
12 #include <linux/jiffies.h>
13 #include <linux/slab.h>
14 #include <linux/time.h>
15 #include <linux/wait.h>
16 #include <linux/module.h>
17 #include <linux/platform_device.h>
18 #include <linux/firmware.h>
19 #include <linux/timer.h>
20 #include <linux/delay.h>
21 #include <linux/workqueue.h>
23 #include <sound/core.h>
24 #include <sound/control.h>
25 #include <sound/pcm.h>
26 #include <sound/initval.h>
27 #include <sound/info.h>
29 #include <mach/sysasic.h>
32 MODULE_AUTHOR("Adrian McMenamin <adrian@mcmen.demon.co.uk>");
33 MODULE_DESCRIPTION("Dreamcast AICA sound (pcm) driver");
34 MODULE_LICENSE("GPL");
35 MODULE_FIRMWARE("aica_firmware.bin");
37 /* module parameters */
38 #define CARD_NAME "AICA"
39 static int index = -1;
41 static bool enable = 1;
42 module_param(index, int, 0444);
43 MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard.");
44 module_param(id, charp, 0444);
45 MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard.");
46 module_param(enable, bool, 0644);
47 MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard.");
49 /* Simple platform device */
50 static struct platform_device *pd;
51 static struct resource aica_memory_space[2] = {
53 .name = "AICA ARM CONTROL",
54 .start = ARM_RESET_REGISTER,
55 .flags = IORESOURCE_MEM,
56 .end = ARM_RESET_REGISTER + 3,
59 .name = "AICA Sound RAM",
60 .start = SPU_MEMORY_BASE,
61 .flags = IORESOURCE_MEM,
62 .end = SPU_MEMORY_BASE + 0x200000 - 1,
66 /* SPU specific functions */
67 /* spu_write_wait - wait for G2-SH FIFO to clear */
68 static void spu_write_wait(void)
73 if (!(readl(G2_FIFO) & 0x11))
75 /* To ensure hardware failure doesn't wedge kernel */
77 if (time_count > 0x10000) {
78 pr_warn("WARNING: G2 FIFO appears to be blocked.\n");
84 /* spu_memset - write to memory in SPU address space */
85 static void spu_memset(u32 toi, u32 what, int length)
89 if (snd_BUG_ON(length % 4))
91 for (i = 0; i < length; i++) {
94 local_irq_save(flags);
95 writel(what, toi + SPU_MEMORY_BASE);
96 local_irq_restore(flags);
101 /* spu_memload - write to SPU address space */
102 static void spu_memload(u32 toi, const void *from, int length)
105 const u32 *froml = from;
106 u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
109 length = DIV_ROUND_UP(length, 4);
111 for (i = 0; i < length; i++) {
115 local_irq_save(flags);
117 local_irq_restore(flags);
123 /* spu_disable - set spu registers to stop sound output */
124 static void spu_disable(void)
130 regval = readl(ARM_RESET_REGISTER);
133 local_irq_save(flags);
134 writel(regval, ARM_RESET_REGISTER);
135 local_irq_restore(flags);
136 for (i = 0; i < 64; i++) {
138 regval = readl(SPU_REGISTER_BASE + (i * 0x80));
139 regval = (regval & ~0x4000) | 0x8000;
141 local_irq_save(flags);
142 writel(regval, SPU_REGISTER_BASE + (i * 0x80));
143 local_irq_restore(flags);
147 /* spu_enable - set spu registers to enable sound output */
148 static void spu_enable(void)
151 u32 regval = readl(ARM_RESET_REGISTER);
154 local_irq_save(flags);
155 writel(regval, ARM_RESET_REGISTER);
156 local_irq_restore(flags);
160 * Halt the sound processor, clear the memory,
161 * load some default ARM7 code, and then restart ARM7
163 static void spu_reset(void)
167 spu_memset(0, 0, 0x200000 / 4);
168 /* Put ARM7 in endless loop */
169 local_irq_save(flags);
170 __raw_writel(0xea000002, SPU_MEMORY_BASE);
171 local_irq_restore(flags);
175 /* aica_chn_start - write to spu to start playback */
176 static void aica_chn_start(void)
180 local_irq_save(flags);
181 writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
182 local_irq_restore(flags);
185 /* aica_chn_halt - write to spu to halt playback */
186 static void aica_chn_halt(void)
190 local_irq_save(flags);
191 writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
192 local_irq_restore(flags);
195 /* ALSA code below */
196 static const struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
197 .info = (SNDRV_PCM_INFO_NONINTERLEAVED),
199 (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
200 SNDRV_PCM_FMTBIT_IMA_ADPCM),
201 .rates = SNDRV_PCM_RATE_8000_48000,
206 .buffer_bytes_max = AICA_BUFFER_SIZE,
207 .period_bytes_min = AICA_PERIOD_SIZE,
208 .period_bytes_max = AICA_PERIOD_SIZE,
209 .periods_min = AICA_PERIOD_NUMBER,
210 .periods_max = AICA_PERIOD_NUMBER,
213 static int aica_dma_transfer(int channels, int buffer_size,
214 struct snd_pcm_substream *substream)
216 int q, err, period_offset;
217 struct snd_card_aica *dreamcastcard;
218 struct snd_pcm_runtime *runtime;
221 dreamcastcard = substream->pcm->private_data;
222 period_offset = dreamcastcard->clicks;
223 period_offset %= (AICA_PERIOD_NUMBER / channels);
224 runtime = substream->runtime;
225 for (q = 0; q < channels; q++) {
226 local_irq_save(flags);
227 err = dma_xfer(AICA_DMA_CHANNEL,
228 (unsigned long) (runtime->dma_area +
229 (AICA_BUFFER_SIZE * q) /
233 AICA_CHANNEL0_OFFSET + q * CHANNEL_OFFSET +
234 AICA_PERIOD_SIZE * period_offset,
235 buffer_size / channels, AICA_DMA_MODE);
236 if (unlikely(err < 0)) {
237 local_irq_restore(flags);
240 dma_wait_for_completion(AICA_DMA_CHANNEL);
241 local_irq_restore(flags);
246 static void startup_aica(struct snd_card_aica *dreamcastcard)
248 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
249 dreamcastcard->channel, sizeof(struct aica_channel));
253 static void run_spu_dma(struct work_struct *work)
256 struct snd_pcm_runtime *runtime;
257 struct snd_card_aica *dreamcastcard;
259 container_of(work, struct snd_card_aica, spu_dma_work);
260 runtime = dreamcastcard->substream->runtime;
261 if (unlikely(dreamcastcard->dma_check == 0)) {
263 frames_to_bytes(runtime, runtime->buffer_size);
264 if (runtime->channels > 1)
265 dreamcastcard->channel->flags |= 0x01;
266 aica_dma_transfer(runtime->channels, buffer_size,
267 dreamcastcard->substream);
268 startup_aica(dreamcastcard);
269 dreamcastcard->clicks =
270 buffer_size / (AICA_PERIOD_SIZE * runtime->channels);
273 aica_dma_transfer(runtime->channels,
274 AICA_PERIOD_SIZE * runtime->channels,
275 dreamcastcard->substream);
276 snd_pcm_period_elapsed(dreamcastcard->substream);
277 dreamcastcard->clicks++;
278 if (unlikely(dreamcastcard->clicks >= AICA_PERIOD_NUMBER))
279 dreamcastcard->clicks %= AICA_PERIOD_NUMBER;
280 if (snd_pcm_running(dreamcastcard->substream))
281 mod_timer(&dreamcastcard->timer, jiffies + 1);
285 static void aica_period_elapsed(struct timer_list *t)
287 struct snd_card_aica *dreamcastcard = from_timer(dreamcastcard,
289 struct snd_pcm_substream *substream = dreamcastcard->substream;
290 /*timer function - so cannot sleep */
292 struct snd_pcm_runtime *runtime;
293 if (!snd_pcm_running(substream))
295 runtime = substream->runtime;
296 dreamcastcard = substream->pcm->private_data;
297 /* Have we played out an additional period? */
299 frames_to_bytes(runtime,
301 (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
303 if (play_period == dreamcastcard->current_period) {
304 /* reschedule the timer */
305 mod_timer(&(dreamcastcard->timer), jiffies + 1);
308 if (runtime->channels > 1)
309 dreamcastcard->current_period = play_period;
310 if (unlikely(dreamcastcard->dma_check == 0))
311 dreamcastcard->dma_check = 1;
312 schedule_work(&(dreamcastcard->spu_dma_work));
315 static void spu_begin_dma(struct snd_pcm_substream *substream)
317 struct snd_card_aica *dreamcastcard;
318 struct snd_pcm_runtime *runtime;
319 runtime = substream->runtime;
320 dreamcastcard = substream->pcm->private_data;
321 /*get the queue to do the work */
322 schedule_work(&(dreamcastcard->spu_dma_work));
323 mod_timer(&dreamcastcard->timer, jiffies + 4);
326 static int snd_aicapcm_pcm_open(struct snd_pcm_substream
329 struct snd_pcm_runtime *runtime;
330 struct aica_channel *channel;
331 struct snd_card_aica *dreamcastcard;
334 dreamcastcard = substream->pcm->private_data;
335 channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
338 /* set defaults for channel */
339 channel->sfmt = SM_8BIT;
340 channel->cmd = AICA_CMD_START;
341 channel->vol = dreamcastcard->master_volume;
344 channel->flags = 0; /* default to mono */
345 dreamcastcard->channel = channel;
346 runtime = substream->runtime;
347 runtime->hw = snd_pcm_aica_playback_hw;
349 dreamcastcard->clicks = 0;
350 dreamcastcard->current_period = 0;
351 dreamcastcard->dma_check = 0;
355 static int snd_aicapcm_pcm_sync_stop(struct snd_pcm_substream *substream)
357 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
359 del_timer_sync(&dreamcastcard->timer);
360 cancel_work_sync(&dreamcastcard->spu_dma_work);
364 static int snd_aicapcm_pcm_close(struct snd_pcm_substream
367 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
368 dreamcastcard->substream = NULL;
369 kfree(dreamcastcard->channel);
374 static int snd_aicapcm_pcm_prepare(struct snd_pcm_substream
377 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
378 if ((substream->runtime)->format == SNDRV_PCM_FORMAT_S16_LE)
379 dreamcastcard->channel->sfmt = SM_16BIT;
380 dreamcastcard->channel->freq = substream->runtime->rate;
381 dreamcastcard->substream = substream;
385 static int snd_aicapcm_pcm_trigger(struct snd_pcm_substream
389 case SNDRV_PCM_TRIGGER_START:
390 spu_begin_dma(substream);
392 case SNDRV_PCM_TRIGGER_STOP:
401 static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream
404 return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER);
407 static const struct snd_pcm_ops snd_aicapcm_playback_ops = {
408 .open = snd_aicapcm_pcm_open,
409 .close = snd_aicapcm_pcm_close,
410 .prepare = snd_aicapcm_pcm_prepare,
411 .trigger = snd_aicapcm_pcm_trigger,
412 .pointer = snd_aicapcm_pcm_pointer,
413 .sync_stop = snd_aicapcm_pcm_sync_stop,
416 /* TO DO: set up to handle more than one pcm instance */
417 static int __init snd_aicapcmchip(struct snd_card_aica
418 *dreamcastcard, int pcm_index)
422 /* AICA has no capture ability */
424 snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
426 if (unlikely(err < 0))
428 pcm->private_data = dreamcastcard;
429 strcpy(pcm->name, "AICA PCM");
430 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
431 &snd_aicapcm_playback_ops);
432 /* Allocate the DMA buffers */
433 snd_pcm_set_managed_buffer_all(pcm,
434 SNDRV_DMA_TYPE_CONTINUOUS,
442 #define aica_pcmswitch_info snd_ctl_boolean_mono_info
444 static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
445 struct snd_ctl_elem_value *ucontrol)
447 ucontrol->value.integer.value[0] = 1; /* TO DO: Fix me */
451 static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
452 struct snd_ctl_elem_value *ucontrol)
454 if (ucontrol->value.integer.value[0] == 1)
455 return 0; /* TO DO: Fix me */
461 static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
462 struct snd_ctl_elem_info *uinfo)
464 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
466 uinfo->value.integer.min = 0;
467 uinfo->value.integer.max = 0xFF;
471 static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
472 struct snd_ctl_elem_value *ucontrol)
474 struct snd_card_aica *dreamcastcard;
475 dreamcastcard = kcontrol->private_data;
476 if (unlikely(!dreamcastcard->channel))
477 return -ETXTBSY; /* we've not yet been set up */
478 ucontrol->value.integer.value[0] = dreamcastcard->channel->vol;
482 static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
483 struct snd_ctl_elem_value *ucontrol)
485 struct snd_card_aica *dreamcastcard;
487 dreamcastcard = kcontrol->private_data;
488 if (unlikely(!dreamcastcard->channel))
490 vol = ucontrol->value.integer.value[0];
493 if (unlikely(dreamcastcard->channel->vol == vol))
495 dreamcastcard->channel->vol = ucontrol->value.integer.value[0];
496 dreamcastcard->master_volume = ucontrol->value.integer.value[0];
497 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
498 dreamcastcard->channel, sizeof(struct aica_channel));
502 static const struct snd_kcontrol_new snd_aica_pcmswitch_control = {
503 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
504 .name = "PCM Playback Switch",
506 .info = aica_pcmswitch_info,
507 .get = aica_pcmswitch_get,
508 .put = aica_pcmswitch_put
511 static const struct snd_kcontrol_new snd_aica_pcmvolume_control = {
512 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
513 .name = "PCM Playback Volume",
515 .info = aica_pcmvolume_info,
516 .get = aica_pcmvolume_get,
517 .put = aica_pcmvolume_put
520 static int load_aica_firmware(void)
523 const struct firmware *fw_entry;
525 err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
528 /* write firmware into memory */
530 spu_memload(0, fw_entry->data, fw_entry->size);
532 release_firmware(fw_entry);
536 static int add_aicamixer_controls(struct snd_card_aica *dreamcastcard)
540 (dreamcastcard->card,
541 snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
542 if (unlikely(err < 0))
545 (dreamcastcard->card,
546 snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
547 if (unlikely(err < 0))
552 static void snd_aica_remove(struct platform_device *devptr)
554 struct snd_card_aica *dreamcastcard;
555 dreamcastcard = platform_get_drvdata(devptr);
556 snd_card_free(dreamcastcard->card);
557 kfree(dreamcastcard);
560 static int snd_aica_probe(struct platform_device *devptr)
563 struct snd_card_aica *dreamcastcard;
564 dreamcastcard = kzalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
565 if (unlikely(!dreamcastcard))
567 err = snd_card_new(&devptr->dev, index, SND_AICA_DRIVER,
568 THIS_MODULE, 0, &dreamcastcard->card);
569 if (unlikely(err < 0)) {
570 kfree(dreamcastcard);
573 strcpy(dreamcastcard->card->driver, "snd_aica");
574 strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
575 strcpy(dreamcastcard->card->longname,
576 "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
577 /* Prepare to use the queue */
578 INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
579 timer_setup(&dreamcastcard->timer, aica_period_elapsed, 0);
580 /* Load the PCM 'chip' */
581 err = snd_aicapcmchip(dreamcastcard, 0);
582 if (unlikely(err < 0))
584 /* Add basic controls */
585 err = add_aicamixer_controls(dreamcastcard);
586 if (unlikely(err < 0))
588 /* Register the card with ALSA subsystem */
589 err = snd_card_register(dreamcastcard->card);
590 if (unlikely(err < 0))
592 platform_set_drvdata(devptr, dreamcastcard);
593 dev_info(&devptr->dev,
594 "ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
597 snd_card_free(dreamcastcard->card);
598 kfree(dreamcastcard);
602 static struct platform_driver snd_aica_driver = {
603 .probe = snd_aica_probe,
604 .remove_new = snd_aica_remove,
606 .name = SND_AICA_DRIVER,
610 static int __init aica_init(void)
613 err = platform_driver_register(&snd_aica_driver);
614 if (unlikely(err < 0))
616 pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
617 aica_memory_space, 2);
619 platform_driver_unregister(&snd_aica_driver);
622 /* Load the firmware */
623 return load_aica_firmware();
626 static void __exit aica_exit(void)
628 platform_device_unregister(pd);
629 platform_driver_unregister(&snd_aica_driver);
630 /* Kill any sound still playing and reset ARM7 to safe state */
634 module_init(aica_init);
635 module_exit(aica_exit);