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_SUPPORTED_DEVICE("{{Yamaha/SEGA, AICA}}");
36 MODULE_FIRMWARE("aica_firmware.bin");
38 /* module parameters */
39 #define CARD_NAME "AICA"
40 static int index = -1;
42 static bool enable = 1;
43 module_param(index, int, 0444);
44 MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard.");
45 module_param(id, charp, 0444);
46 MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard.");
47 module_param(enable, bool, 0644);
48 MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard.");
50 /* Simple platform device */
51 static struct platform_device *pd;
52 static struct resource aica_memory_space[2] = {
54 .name = "AICA ARM CONTROL",
55 .start = ARM_RESET_REGISTER,
56 .flags = IORESOURCE_MEM,
57 .end = ARM_RESET_REGISTER + 3,
60 .name = "AICA Sound RAM",
61 .start = SPU_MEMORY_BASE,
62 .flags = IORESOURCE_MEM,
63 .end = SPU_MEMORY_BASE + 0x200000 - 1,
67 /* SPU specific functions */
68 /* spu_write_wait - wait for G2-SH FIFO to clear */
69 static void spu_write_wait(void)
74 if (!(readl(G2_FIFO) & 0x11))
76 /* To ensure hardware failure doesn't wedge kernel */
78 if (time_count > 0x10000) {
80 ("WARNING: G2 FIFO appears to be blocked.\n");
86 /* spu_memset - write to memory in SPU address space */
87 static void spu_memset(u32 toi, u32 what, int length)
91 if (snd_BUG_ON(length % 4))
93 for (i = 0; i < length; i++) {
96 local_irq_save(flags);
97 writel(what, toi + SPU_MEMORY_BASE);
98 local_irq_restore(flags);
103 /* spu_memload - write to SPU address space */
104 static void spu_memload(u32 toi, const void *from, int length)
107 const u32 *froml = from;
108 u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
111 length = DIV_ROUND_UP(length, 4);
113 for (i = 0; i < length; i++) {
117 local_irq_save(flags);
119 local_irq_restore(flags);
125 /* spu_disable - set spu registers to stop sound output */
126 static void spu_disable(void)
132 regval = readl(ARM_RESET_REGISTER);
135 local_irq_save(flags);
136 writel(regval, ARM_RESET_REGISTER);
137 local_irq_restore(flags);
138 for (i = 0; i < 64; i++) {
140 regval = readl(SPU_REGISTER_BASE + (i * 0x80));
141 regval = (regval & ~0x4000) | 0x8000;
143 local_irq_save(flags);
144 writel(regval, SPU_REGISTER_BASE + (i * 0x80));
145 local_irq_restore(flags);
149 /* spu_enable - set spu registers to enable sound output */
150 static void spu_enable(void)
153 u32 regval = readl(ARM_RESET_REGISTER);
156 local_irq_save(flags);
157 writel(regval, ARM_RESET_REGISTER);
158 local_irq_restore(flags);
162 * Halt the sound processor, clear the memory,
163 * load some default ARM7 code, and then restart ARM7
165 static void spu_reset(void)
169 spu_memset(0, 0, 0x200000 / 4);
170 /* Put ARM7 in endless loop */
171 local_irq_save(flags);
172 __raw_writel(0xea000002, SPU_MEMORY_BASE);
173 local_irq_restore(flags);
177 /* aica_chn_start - write to spu to start playback */
178 static void aica_chn_start(void)
182 local_irq_save(flags);
183 writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
184 local_irq_restore(flags);
187 /* aica_chn_halt - write to spu to halt playback */
188 static void aica_chn_halt(void)
192 local_irq_save(flags);
193 writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
194 local_irq_restore(flags);
197 /* ALSA code below */
198 static const struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
199 .info = (SNDRV_PCM_INFO_NONINTERLEAVED),
201 (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
202 SNDRV_PCM_FMTBIT_IMA_ADPCM),
203 .rates = SNDRV_PCM_RATE_8000_48000,
208 .buffer_bytes_max = AICA_BUFFER_SIZE,
209 .period_bytes_min = AICA_PERIOD_SIZE,
210 .period_bytes_max = AICA_PERIOD_SIZE,
211 .periods_min = AICA_PERIOD_NUMBER,
212 .periods_max = AICA_PERIOD_NUMBER,
215 static int aica_dma_transfer(int channels, int buffer_size,
216 struct snd_pcm_substream *substream)
218 int q, err, period_offset;
219 struct snd_card_aica *dreamcastcard;
220 struct snd_pcm_runtime *runtime;
223 dreamcastcard = substream->pcm->private_data;
224 period_offset = dreamcastcard->clicks;
225 period_offset %= (AICA_PERIOD_NUMBER / channels);
226 runtime = substream->runtime;
227 for (q = 0; q < channels; q++) {
228 local_irq_save(flags);
229 err = dma_xfer(AICA_DMA_CHANNEL,
230 (unsigned long) (runtime->dma_area +
231 (AICA_BUFFER_SIZE * q) /
235 AICA_CHANNEL0_OFFSET + q * CHANNEL_OFFSET +
236 AICA_PERIOD_SIZE * period_offset,
237 buffer_size / channels, AICA_DMA_MODE);
238 if (unlikely(err < 0)) {
239 local_irq_restore(flags);
242 dma_wait_for_completion(AICA_DMA_CHANNEL);
243 local_irq_restore(flags);
248 static void startup_aica(struct snd_card_aica *dreamcastcard)
250 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
251 dreamcastcard->channel, sizeof(struct aica_channel));
255 static void run_spu_dma(struct work_struct *work)
258 struct snd_pcm_runtime *runtime;
259 struct snd_card_aica *dreamcastcard;
261 container_of(work, struct snd_card_aica, spu_dma_work);
262 runtime = dreamcastcard->substream->runtime;
263 if (unlikely(dreamcastcard->dma_check == 0)) {
265 frames_to_bytes(runtime, runtime->buffer_size);
266 if (runtime->channels > 1)
267 dreamcastcard->channel->flags |= 0x01;
268 aica_dma_transfer(runtime->channels, buffer_size,
269 dreamcastcard->substream);
270 startup_aica(dreamcastcard);
271 dreamcastcard->clicks =
272 buffer_size / (AICA_PERIOD_SIZE * runtime->channels);
275 aica_dma_transfer(runtime->channels,
276 AICA_PERIOD_SIZE * runtime->channels,
277 dreamcastcard->substream);
278 snd_pcm_period_elapsed(dreamcastcard->substream);
279 dreamcastcard->clicks++;
280 if (unlikely(dreamcastcard->clicks >= AICA_PERIOD_NUMBER))
281 dreamcastcard->clicks %= AICA_PERIOD_NUMBER;
282 if (snd_pcm_running(dreamcastcard->substream))
283 mod_timer(&dreamcastcard->timer, jiffies + 1);
287 static void aica_period_elapsed(struct timer_list *t)
289 struct snd_card_aica *dreamcastcard = from_timer(dreamcastcard,
291 struct snd_pcm_substream *substream = dreamcastcard->substream;
292 /*timer function - so cannot sleep */
294 struct snd_pcm_runtime *runtime;
295 if (!snd_pcm_running(substream))
297 runtime = substream->runtime;
298 dreamcastcard = substream->pcm->private_data;
299 /* Have we played out an additional period? */
301 frames_to_bytes(runtime,
303 (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
305 if (play_period == dreamcastcard->current_period) {
306 /* reschedule the timer */
307 mod_timer(&(dreamcastcard->timer), jiffies + 1);
310 if (runtime->channels > 1)
311 dreamcastcard->current_period = play_period;
312 if (unlikely(dreamcastcard->dma_check == 0))
313 dreamcastcard->dma_check = 1;
314 schedule_work(&(dreamcastcard->spu_dma_work));
317 static void spu_begin_dma(struct snd_pcm_substream *substream)
319 struct snd_card_aica *dreamcastcard;
320 struct snd_pcm_runtime *runtime;
321 runtime = substream->runtime;
322 dreamcastcard = substream->pcm->private_data;
323 /*get the queue to do the work */
324 schedule_work(&(dreamcastcard->spu_dma_work));
325 mod_timer(&dreamcastcard->timer, jiffies + 4);
328 static int snd_aicapcm_pcm_open(struct snd_pcm_substream
331 struct snd_pcm_runtime *runtime;
332 struct aica_channel *channel;
333 struct snd_card_aica *dreamcastcard;
336 dreamcastcard = substream->pcm->private_data;
337 channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
340 /* set defaults for channel */
341 channel->sfmt = SM_8BIT;
342 channel->cmd = AICA_CMD_START;
343 channel->vol = dreamcastcard->master_volume;
346 channel->flags = 0; /* default to mono */
347 dreamcastcard->channel = channel;
348 runtime = substream->runtime;
349 runtime->hw = snd_pcm_aica_playback_hw;
351 dreamcastcard->clicks = 0;
352 dreamcastcard->current_period = 0;
353 dreamcastcard->dma_check = 0;
357 static int snd_aicapcm_pcm_sync_stop(struct snd_pcm_substream *substream)
359 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
361 del_timer_sync(&dreamcastcard->timer);
362 cancel_work_sync(&dreamcastcard->spu_dma_work);
366 static int snd_aicapcm_pcm_close(struct snd_pcm_substream
369 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
370 dreamcastcard->substream = NULL;
371 kfree(dreamcastcard->channel);
376 static int snd_aicapcm_pcm_prepare(struct snd_pcm_substream
379 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
380 if ((substream->runtime)->format == SNDRV_PCM_FORMAT_S16_LE)
381 dreamcastcard->channel->sfmt = SM_16BIT;
382 dreamcastcard->channel->freq = substream->runtime->rate;
383 dreamcastcard->substream = substream;
387 static int snd_aicapcm_pcm_trigger(struct snd_pcm_substream
391 case SNDRV_PCM_TRIGGER_START:
392 spu_begin_dma(substream);
394 case SNDRV_PCM_TRIGGER_STOP:
403 static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream
406 return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER);
409 static const struct snd_pcm_ops snd_aicapcm_playback_ops = {
410 .open = snd_aicapcm_pcm_open,
411 .close = snd_aicapcm_pcm_close,
412 .prepare = snd_aicapcm_pcm_prepare,
413 .trigger = snd_aicapcm_pcm_trigger,
414 .pointer = snd_aicapcm_pcm_pointer,
415 .sync_stop = snd_aicapcm_pcm_sync_stop,
418 /* TO DO: set up to handle more than one pcm instance */
419 static int __init snd_aicapcmchip(struct snd_card_aica
420 *dreamcastcard, int pcm_index)
424 /* AICA has no capture ability */
426 snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
428 if (unlikely(err < 0))
430 pcm->private_data = dreamcastcard;
431 strcpy(pcm->name, "AICA PCM");
432 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
433 &snd_aicapcm_playback_ops);
434 /* Allocate the DMA buffers */
435 snd_pcm_set_managed_buffer_all(pcm,
436 SNDRV_DMA_TYPE_CONTINUOUS,
444 #define aica_pcmswitch_info snd_ctl_boolean_mono_info
446 static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
447 struct snd_ctl_elem_value *ucontrol)
449 ucontrol->value.integer.value[0] = 1; /* TO DO: Fix me */
453 static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
454 struct snd_ctl_elem_value *ucontrol)
456 if (ucontrol->value.integer.value[0] == 1)
457 return 0; /* TO DO: Fix me */
463 static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
464 struct snd_ctl_elem_info *uinfo)
466 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
468 uinfo->value.integer.min = 0;
469 uinfo->value.integer.max = 0xFF;
473 static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
474 struct snd_ctl_elem_value *ucontrol)
476 struct snd_card_aica *dreamcastcard;
477 dreamcastcard = kcontrol->private_data;
478 if (unlikely(!dreamcastcard->channel))
479 return -ETXTBSY; /* we've not yet been set up */
480 ucontrol->value.integer.value[0] = dreamcastcard->channel->vol;
484 static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
485 struct snd_ctl_elem_value *ucontrol)
487 struct snd_card_aica *dreamcastcard;
489 dreamcastcard = kcontrol->private_data;
490 if (unlikely(!dreamcastcard->channel))
492 vol = ucontrol->value.integer.value[0];
495 if (unlikely(dreamcastcard->channel->vol == vol))
497 dreamcastcard->channel->vol = ucontrol->value.integer.value[0];
498 dreamcastcard->master_volume = ucontrol->value.integer.value[0];
499 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
500 dreamcastcard->channel, sizeof(struct aica_channel));
504 static const struct snd_kcontrol_new snd_aica_pcmswitch_control = {
505 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
506 .name = "PCM Playback Switch",
508 .info = aica_pcmswitch_info,
509 .get = aica_pcmswitch_get,
510 .put = aica_pcmswitch_put
513 static const struct snd_kcontrol_new snd_aica_pcmvolume_control = {
514 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
515 .name = "PCM Playback Volume",
517 .info = aica_pcmvolume_info,
518 .get = aica_pcmvolume_get,
519 .put = aica_pcmvolume_put
522 static int load_aica_firmware(void)
525 const struct firmware *fw_entry;
527 err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
530 /* write firmware into memory */
532 spu_memload(0, fw_entry->data, fw_entry->size);
534 release_firmware(fw_entry);
538 static int add_aicamixer_controls(struct snd_card_aica *dreamcastcard)
542 (dreamcastcard->card,
543 snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
544 if (unlikely(err < 0))
547 (dreamcastcard->card,
548 snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
549 if (unlikely(err < 0))
554 static int snd_aica_remove(struct platform_device *devptr)
556 struct snd_card_aica *dreamcastcard;
557 dreamcastcard = platform_get_drvdata(devptr);
558 if (unlikely(!dreamcastcard))
560 snd_card_free(dreamcastcard->card);
561 kfree(dreamcastcard);
565 static int snd_aica_probe(struct platform_device *devptr)
568 struct snd_card_aica *dreamcastcard;
569 dreamcastcard = kzalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
570 if (unlikely(!dreamcastcard))
572 err = snd_card_new(&devptr->dev, index, SND_AICA_DRIVER,
573 THIS_MODULE, 0, &dreamcastcard->card);
574 if (unlikely(err < 0)) {
575 kfree(dreamcastcard);
578 strcpy(dreamcastcard->card->driver, "snd_aica");
579 strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
580 strcpy(dreamcastcard->card->longname,
581 "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
582 /* Prepare to use the queue */
583 INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
584 timer_setup(&dreamcastcard->timer, aica_period_elapsed, 0);
585 /* Load the PCM 'chip' */
586 err = snd_aicapcmchip(dreamcastcard, 0);
587 if (unlikely(err < 0))
589 /* Add basic controls */
590 err = add_aicamixer_controls(dreamcastcard);
591 if (unlikely(err < 0))
593 /* Register the card with ALSA subsystem */
594 err = snd_card_register(dreamcastcard->card);
595 if (unlikely(err < 0))
597 platform_set_drvdata(devptr, dreamcastcard);
599 ("ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
602 snd_card_free(dreamcastcard->card);
603 kfree(dreamcastcard);
607 static struct platform_driver snd_aica_driver = {
608 .probe = snd_aica_probe,
609 .remove = snd_aica_remove,
611 .name = SND_AICA_DRIVER,
615 static int __init aica_init(void)
618 err = platform_driver_register(&snd_aica_driver);
619 if (unlikely(err < 0))
621 pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
622 aica_memory_space, 2);
624 platform_driver_unregister(&snd_aica_driver);
627 /* Load the firmware */
628 return load_aica_firmware();
631 static void __exit aica_exit(void)
633 platform_device_unregister(pd);
634 platform_driver_unregister(&snd_aica_driver);
635 /* Kill any sound still playing and reset ARM7 to safe state */
639 module_init(aica_init);
640 module_exit(aica_exit);