Loading...
1/*
2* This code is licenced under
3* the General Public Licence
4* version 2
5*
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/
10* or the maintainer
11*
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.
15*
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.
20*
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
24*
25*/
26
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>
38#include <linux/io.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>
44#include <asm/dma.h>
45#include <mach/sysasic.h>
46#include "aica.h"
47
48MODULE_AUTHOR("Adrian McMenamin <adrian@mcmen.demon.co.uk>");
49MODULE_DESCRIPTION("Dreamcast AICA sound (pcm) driver");
50MODULE_LICENSE("GPL");
51MODULE_SUPPORTED_DEVICE("{{Yamaha/SEGA, AICA}}");
52MODULE_FIRMWARE("aica_firmware.bin");
53
54/* module parameters */
55#define CARD_NAME "AICA"
56static int index = -1;
57static char *id;
58static bool enable = 1;
59module_param(index, int, 0444);
60MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard.");
61module_param(id, charp, 0444);
62MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard.");
63module_param(enable, bool, 0644);
64MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard.");
65
66/* Simple platform device */
67static struct platform_device *pd;
68static struct resource aica_memory_space[2] = {
69 {
70 .name = "AICA ARM CONTROL",
71 .start = ARM_RESET_REGISTER,
72 .flags = IORESOURCE_MEM,
73 .end = ARM_RESET_REGISTER + 3,
74 },
75 {
76 .name = "AICA Sound RAM",
77 .start = SPU_MEMORY_BASE,
78 .flags = IORESOURCE_MEM,
79 .end = SPU_MEMORY_BASE + 0x200000 - 1,
80 },
81};
82
83/* SPU specific functions */
84/* spu_write_wait - wait for G2-SH FIFO to clear */
85static void spu_write_wait(void)
86{
87 int time_count;
88 time_count = 0;
89 while (1) {
90 if (!(readl(G2_FIFO) & 0x11))
91 break;
92 /* To ensure hardware failure doesn't wedge kernel */
93 time_count++;
94 if (time_count > 0x10000) {
95 snd_printk
96 ("WARNING: G2 FIFO appears to be blocked.\n");
97 break;
98 }
99 }
100}
101
102/* spu_memset - write to memory in SPU address space */
103static void spu_memset(u32 toi, u32 what, int length)
104{
105 int i;
106 unsigned long flags;
107 if (snd_BUG_ON(length % 4))
108 return;
109 for (i = 0; i < length; i++) {
110 if (!(i % 8))
111 spu_write_wait();
112 local_irq_save(flags);
113 writel(what, toi + SPU_MEMORY_BASE);
114 local_irq_restore(flags);
115 toi++;
116 }
117}
118
119/* spu_memload - write to SPU address space */
120static void spu_memload(u32 toi, void *from, int length)
121{
122 unsigned long flags;
123 u32 *froml = from;
124 u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
125 int i;
126 u32 val;
127 length = DIV_ROUND_UP(length, 4);
128 spu_write_wait();
129 for (i = 0; i < length; i++) {
130 if (!(i % 8))
131 spu_write_wait();
132 val = *froml;
133 local_irq_save(flags);
134 writel(val, to);
135 local_irq_restore(flags);
136 froml++;
137 to++;
138 }
139}
140
141/* spu_disable - set spu registers to stop sound output */
142static void spu_disable(void)
143{
144 int i;
145 unsigned long flags;
146 u32 regval;
147 spu_write_wait();
148 regval = readl(ARM_RESET_REGISTER);
149 regval |= 1;
150 spu_write_wait();
151 local_irq_save(flags);
152 writel(regval, ARM_RESET_REGISTER);
153 local_irq_restore(flags);
154 for (i = 0; i < 64; i++) {
155 spu_write_wait();
156 regval = readl(SPU_REGISTER_BASE + (i * 0x80));
157 regval = (regval & ~0x4000) | 0x8000;
158 spu_write_wait();
159 local_irq_save(flags);
160 writel(regval, SPU_REGISTER_BASE + (i * 0x80));
161 local_irq_restore(flags);
162 }
163}
164
165/* spu_enable - set spu registers to enable sound output */
166static void spu_enable(void)
167{
168 unsigned long flags;
169 u32 regval = readl(ARM_RESET_REGISTER);
170 regval &= ~1;
171 spu_write_wait();
172 local_irq_save(flags);
173 writel(regval, ARM_RESET_REGISTER);
174 local_irq_restore(flags);
175}
176
177/*
178 * Halt the sound processor, clear the memory,
179 * load some default ARM7 code, and then restart ARM7
180*/
181static void spu_reset(void)
182{
183 unsigned long flags;
184 spu_disable();
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);
190 spu_enable();
191}
192
193/* aica_chn_start - write to spu to start playback */
194static void aica_chn_start(void)
195{
196 unsigned long flags;
197 spu_write_wait();
198 local_irq_save(flags);
199 writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
200 local_irq_restore(flags);
201}
202
203/* aica_chn_halt - write to spu to halt playback */
204static void aica_chn_halt(void)
205{
206 unsigned long flags;
207 spu_write_wait();
208 local_irq_save(flags);
209 writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
210 local_irq_restore(flags);
211}
212
213/* ALSA code below */
214static const struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
215 .info = (SNDRV_PCM_INFO_NONINTERLEAVED),
216 .formats =
217 (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
218 SNDRV_PCM_FMTBIT_IMA_ADPCM),
219 .rates = SNDRV_PCM_RATE_8000_48000,
220 .rate_min = 8000,
221 .rate_max = 48000,
222 .channels_min = 1,
223 .channels_max = 2,
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,
229};
230
231static int aica_dma_transfer(int channels, int buffer_size,
232 struct snd_pcm_substream *substream)
233{
234 int q, err, period_offset;
235 struct snd_card_aica *dreamcastcard;
236 struct snd_pcm_runtime *runtime;
237 unsigned long flags;
238 err = 0;
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) /
248 channels +
249 AICA_PERIOD_SIZE *
250 period_offset),
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);
256 break;
257 }
258 dma_wait_for_completion(AICA_DMA_CHANNEL);
259 local_irq_restore(flags);
260 }
261 return err;
262}
263
264static void startup_aica(struct snd_card_aica *dreamcastcard)
265{
266 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
267 dreamcastcard->channel, sizeof(struct aica_channel));
268 aica_chn_start();
269}
270
271static void run_spu_dma(struct work_struct *work)
272{
273 int buffer_size;
274 struct snd_pcm_runtime *runtime;
275 struct snd_card_aica *dreamcastcard;
276 dreamcastcard =
277 container_of(work, struct snd_card_aica, spu_dma_work);
278 runtime = dreamcastcard->substream->runtime;
279 if (unlikely(dreamcastcard->dma_check == 0)) {
280 buffer_size =
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);
289 return;
290 } else {
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 mod_timer(&dreamcastcard->timer, jiffies + 1);
299 }
300}
301
302static void aica_period_elapsed(struct timer_list *t)
303{
304 struct snd_card_aica *dreamcastcard = from_timer(dreamcastcard,
305 t, timer);
306 struct snd_pcm_substream *substream = dreamcastcard->timer_substream;
307 /*timer function - so cannot sleep */
308 int play_period;
309 struct snd_pcm_runtime *runtime;
310 runtime = substream->runtime;
311 dreamcastcard = substream->pcm->private_data;
312 /* Have we played out an additional period? */
313 play_period =
314 frames_to_bytes(runtime,
315 readl
316 (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
317 AICA_PERIOD_SIZE;
318 if (play_period == dreamcastcard->current_period) {
319 /* reschedule the timer */
320 mod_timer(&(dreamcastcard->timer), jiffies + 1);
321 return;
322 }
323 if (runtime->channels > 1)
324 dreamcastcard->current_period = play_period;
325 if (unlikely(dreamcastcard->dma_check == 0))
326 dreamcastcard->dma_check = 1;
327 schedule_work(&(dreamcastcard->spu_dma_work));
328}
329
330static void spu_begin_dma(struct snd_pcm_substream *substream)
331{
332 struct snd_card_aica *dreamcastcard;
333 struct snd_pcm_runtime *runtime;
334 runtime = substream->runtime;
335 dreamcastcard = substream->pcm->private_data;
336 /*get the queue to do the work */
337 schedule_work(&(dreamcastcard->spu_dma_work));
338 /* Timer may already be running */
339 if (unlikely(dreamcastcard->timer_substream)) {
340 mod_timer(&dreamcastcard->timer, jiffies + 4);
341 return;
342 }
343 timer_setup(&dreamcastcard->timer, aica_period_elapsed, 0);
344 dreamcastcard->timer_substream = substream;
345 mod_timer(&dreamcastcard->timer, jiffies + 4);
346}
347
348static int snd_aicapcm_pcm_open(struct snd_pcm_substream
349 *substream)
350{
351 struct snd_pcm_runtime *runtime;
352 struct aica_channel *channel;
353 struct snd_card_aica *dreamcastcard;
354 if (!enable)
355 return -ENOENT;
356 dreamcastcard = substream->pcm->private_data;
357 channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
358 if (!channel)
359 return -ENOMEM;
360 /* set defaults for channel */
361 channel->sfmt = SM_8BIT;
362 channel->cmd = AICA_CMD_START;
363 channel->vol = dreamcastcard->master_volume;
364 channel->pan = 0x80;
365 channel->pos = 0;
366 channel->flags = 0; /* default to mono */
367 dreamcastcard->channel = channel;
368 runtime = substream->runtime;
369 runtime->hw = snd_pcm_aica_playback_hw;
370 spu_enable();
371 dreamcastcard->clicks = 0;
372 dreamcastcard->current_period = 0;
373 dreamcastcard->dma_check = 0;
374 return 0;
375}
376
377static int snd_aicapcm_pcm_close(struct snd_pcm_substream
378 *substream)
379{
380 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
381 flush_work(&(dreamcastcard->spu_dma_work));
382 if (dreamcastcard->timer_substream)
383 del_timer(&dreamcastcard->timer);
384 kfree(dreamcastcard->channel);
385 spu_disable();
386 return 0;
387}
388
389static int snd_aicapcm_pcm_hw_free(struct snd_pcm_substream
390 *substream)
391{
392 /* Free the DMA buffer */
393 return snd_pcm_lib_free_pages(substream);
394}
395
396static int snd_aicapcm_pcm_hw_params(struct snd_pcm_substream
397 *substream, struct snd_pcm_hw_params
398 *hw_params)
399{
400 /* Allocate a DMA buffer using ALSA built-ins */
401 return
402 snd_pcm_lib_malloc_pages(substream,
403 params_buffer_bytes(hw_params));
404}
405
406static int snd_aicapcm_pcm_prepare(struct snd_pcm_substream
407 *substream)
408{
409 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
410 if ((substream->runtime)->format == SNDRV_PCM_FORMAT_S16_LE)
411 dreamcastcard->channel->sfmt = SM_16BIT;
412 dreamcastcard->channel->freq = substream->runtime->rate;
413 dreamcastcard->substream = substream;
414 return 0;
415}
416
417static int snd_aicapcm_pcm_trigger(struct snd_pcm_substream
418 *substream, int cmd)
419{
420 switch (cmd) {
421 case SNDRV_PCM_TRIGGER_START:
422 spu_begin_dma(substream);
423 break;
424 case SNDRV_PCM_TRIGGER_STOP:
425 aica_chn_halt();
426 break;
427 default:
428 return -EINVAL;
429 }
430 return 0;
431}
432
433static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream
434 *substream)
435{
436 return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER);
437}
438
439static const struct snd_pcm_ops snd_aicapcm_playback_ops = {
440 .open = snd_aicapcm_pcm_open,
441 .close = snd_aicapcm_pcm_close,
442 .ioctl = snd_pcm_lib_ioctl,
443 .hw_params = snd_aicapcm_pcm_hw_params,
444 .hw_free = snd_aicapcm_pcm_hw_free,
445 .prepare = snd_aicapcm_pcm_prepare,
446 .trigger = snd_aicapcm_pcm_trigger,
447 .pointer = snd_aicapcm_pcm_pointer,
448};
449
450/* TO DO: set up to handle more than one pcm instance */
451static int __init snd_aicapcmchip(struct snd_card_aica
452 *dreamcastcard, int pcm_index)
453{
454 struct snd_pcm *pcm;
455 int err;
456 /* AICA has no capture ability */
457 err =
458 snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
459 &pcm);
460 if (unlikely(err < 0))
461 return err;
462 pcm->private_data = dreamcastcard;
463 strcpy(pcm->name, "AICA PCM");
464 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
465 &snd_aicapcm_playback_ops);
466 /* Allocate the DMA buffers */
467 err =
468 snd_pcm_lib_preallocate_pages_for_all(pcm,
469 SNDRV_DMA_TYPE_CONTINUOUS,
470 snd_dma_continuous_data
471 (GFP_KERNEL),
472 AICA_BUFFER_SIZE,
473 AICA_BUFFER_SIZE);
474 return err;
475}
476
477/* Mixer controls */
478#define aica_pcmswitch_info snd_ctl_boolean_mono_info
479
480static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
481 struct snd_ctl_elem_value *ucontrol)
482{
483 ucontrol->value.integer.value[0] = 1; /* TO DO: Fix me */
484 return 0;
485}
486
487static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
488 struct snd_ctl_elem_value *ucontrol)
489{
490 if (ucontrol->value.integer.value[0] == 1)
491 return 0; /* TO DO: Fix me */
492 else
493 aica_chn_halt();
494 return 0;
495}
496
497static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
498 struct snd_ctl_elem_info *uinfo)
499{
500 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
501 uinfo->count = 1;
502 uinfo->value.integer.min = 0;
503 uinfo->value.integer.max = 0xFF;
504 return 0;
505}
506
507static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
508 struct snd_ctl_elem_value *ucontrol)
509{
510 struct snd_card_aica *dreamcastcard;
511 dreamcastcard = kcontrol->private_data;
512 if (unlikely(!dreamcastcard->channel))
513 return -ETXTBSY; /* we've not yet been set up */
514 ucontrol->value.integer.value[0] = dreamcastcard->channel->vol;
515 return 0;
516}
517
518static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
519 struct snd_ctl_elem_value *ucontrol)
520{
521 struct snd_card_aica *dreamcastcard;
522 unsigned int vol;
523 dreamcastcard = kcontrol->private_data;
524 if (unlikely(!dreamcastcard->channel))
525 return -ETXTBSY;
526 vol = ucontrol->value.integer.value[0];
527 if (vol > 0xff)
528 return -EINVAL;
529 if (unlikely(dreamcastcard->channel->vol == vol))
530 return 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));
535 return 1;
536}
537
538static const struct snd_kcontrol_new snd_aica_pcmswitch_control = {
539 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
540 .name = "PCM Playback Switch",
541 .index = 0,
542 .info = aica_pcmswitch_info,
543 .get = aica_pcmswitch_get,
544 .put = aica_pcmswitch_put
545};
546
547static const struct snd_kcontrol_new snd_aica_pcmvolume_control = {
548 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
549 .name = "PCM Playback Volume",
550 .index = 0,
551 .info = aica_pcmvolume_info,
552 .get = aica_pcmvolume_get,
553 .put = aica_pcmvolume_put
554};
555
556static int load_aica_firmware(void)
557{
558 int err;
559 const struct firmware *fw_entry;
560 spu_reset();
561 err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
562 if (unlikely(err))
563 return err;
564 /* write firmware into memory */
565 spu_disable();
566 spu_memload(0, fw_entry->data, fw_entry->size);
567 spu_enable();
568 release_firmware(fw_entry);
569 return err;
570}
571
572static int add_aicamixer_controls(struct snd_card_aica *dreamcastcard)
573{
574 int err;
575 err = snd_ctl_add
576 (dreamcastcard->card,
577 snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
578 if (unlikely(err < 0))
579 return err;
580 err = snd_ctl_add
581 (dreamcastcard->card,
582 snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
583 if (unlikely(err < 0))
584 return err;
585 return 0;
586}
587
588static int snd_aica_remove(struct platform_device *devptr)
589{
590 struct snd_card_aica *dreamcastcard;
591 dreamcastcard = platform_get_drvdata(devptr);
592 if (unlikely(!dreamcastcard))
593 return -ENODEV;
594 snd_card_free(dreamcastcard->card);
595 kfree(dreamcastcard);
596 return 0;
597}
598
599static int snd_aica_probe(struct platform_device *devptr)
600{
601 int err;
602 struct snd_card_aica *dreamcastcard;
603 dreamcastcard = kzalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
604 if (unlikely(!dreamcastcard))
605 return -ENOMEM;
606 err = snd_card_new(&devptr->dev, index, SND_AICA_DRIVER,
607 THIS_MODULE, 0, &dreamcastcard->card);
608 if (unlikely(err < 0)) {
609 kfree(dreamcastcard);
610 return err;
611 }
612 strcpy(dreamcastcard->card->driver, "snd_aica");
613 strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
614 strcpy(dreamcastcard->card->longname,
615 "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
616 /* Prepare to use the queue */
617 INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
618 /* Load the PCM 'chip' */
619 err = snd_aicapcmchip(dreamcastcard, 0);
620 if (unlikely(err < 0))
621 goto freedreamcast;
622 /* Add basic controls */
623 err = add_aicamixer_controls(dreamcastcard);
624 if (unlikely(err < 0))
625 goto freedreamcast;
626 /* Register the card with ALSA subsystem */
627 err = snd_card_register(dreamcastcard->card);
628 if (unlikely(err < 0))
629 goto freedreamcast;
630 platform_set_drvdata(devptr, dreamcastcard);
631 snd_printk
632 ("ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
633 return 0;
634 freedreamcast:
635 snd_card_free(dreamcastcard->card);
636 kfree(dreamcastcard);
637 return err;
638}
639
640static struct platform_driver snd_aica_driver = {
641 .probe = snd_aica_probe,
642 .remove = snd_aica_remove,
643 .driver = {
644 .name = SND_AICA_DRIVER,
645 },
646};
647
648static int __init aica_init(void)
649{
650 int err;
651 err = platform_driver_register(&snd_aica_driver);
652 if (unlikely(err < 0))
653 return err;
654 pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
655 aica_memory_space, 2);
656 if (IS_ERR(pd)) {
657 platform_driver_unregister(&snd_aica_driver);
658 return PTR_ERR(pd);
659 }
660 /* Load the firmware */
661 return load_aica_firmware();
662}
663
664static void __exit aica_exit(void)
665{
666 platform_device_unregister(pd);
667 platform_driver_unregister(&snd_aica_driver);
668 /* Kill any sound still playing and reset ARM7 to safe state */
669 spu_reset();
670}
671
672module_init(aica_init);
673module_exit(aica_exit);
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3*
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/
8* or the maintainer
9*/
10
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>
22#include <linux/io.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>
28#include <asm/dma.h>
29#include <mach/sysasic.h>
30#include "aica.h"
31
32MODULE_AUTHOR("Adrian McMenamin <adrian@mcmen.demon.co.uk>");
33MODULE_DESCRIPTION("Dreamcast AICA sound (pcm) driver");
34MODULE_LICENSE("GPL");
35MODULE_FIRMWARE("aica_firmware.bin");
36
37/* module parameters */
38#define CARD_NAME "AICA"
39static int index = -1;
40static char *id;
41static bool enable = 1;
42module_param(index, int, 0444);
43MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard.");
44module_param(id, charp, 0444);
45MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard.");
46module_param(enable, bool, 0644);
47MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard.");
48
49/* Simple platform device */
50static struct platform_device *pd;
51static struct resource aica_memory_space[2] = {
52 {
53 .name = "AICA ARM CONTROL",
54 .start = ARM_RESET_REGISTER,
55 .flags = IORESOURCE_MEM,
56 .end = ARM_RESET_REGISTER + 3,
57 },
58 {
59 .name = "AICA Sound RAM",
60 .start = SPU_MEMORY_BASE,
61 .flags = IORESOURCE_MEM,
62 .end = SPU_MEMORY_BASE + 0x200000 - 1,
63 },
64};
65
66/* SPU specific functions */
67/* spu_write_wait - wait for G2-SH FIFO to clear */
68static void spu_write_wait(void)
69{
70 int time_count;
71 time_count = 0;
72 while (1) {
73 if (!(readl(G2_FIFO) & 0x11))
74 break;
75 /* To ensure hardware failure doesn't wedge kernel */
76 time_count++;
77 if (time_count > 0x10000) {
78 pr_warn("WARNING: G2 FIFO appears to be blocked.\n");
79 break;
80 }
81 }
82}
83
84/* spu_memset - write to memory in SPU address space */
85static void spu_memset(u32 toi, u32 what, int length)
86{
87 int i;
88 unsigned long flags;
89 if (snd_BUG_ON(length % 4))
90 return;
91 for (i = 0; i < length; i++) {
92 if (!(i % 8))
93 spu_write_wait();
94 local_irq_save(flags);
95 writel(what, toi + SPU_MEMORY_BASE);
96 local_irq_restore(flags);
97 toi++;
98 }
99}
100
101/* spu_memload - write to SPU address space */
102static void spu_memload(u32 toi, const void *from, int length)
103{
104 unsigned long flags;
105 const u32 *froml = from;
106 u32 __iomem *to = (u32 __iomem *) (SPU_MEMORY_BASE + toi);
107 int i;
108 u32 val;
109 length = DIV_ROUND_UP(length, 4);
110 spu_write_wait();
111 for (i = 0; i < length; i++) {
112 if (!(i % 8))
113 spu_write_wait();
114 val = *froml;
115 local_irq_save(flags);
116 writel(val, to);
117 local_irq_restore(flags);
118 froml++;
119 to++;
120 }
121}
122
123/* spu_disable - set spu registers to stop sound output */
124static void spu_disable(void)
125{
126 int i;
127 unsigned long flags;
128 u32 regval;
129 spu_write_wait();
130 regval = readl(ARM_RESET_REGISTER);
131 regval |= 1;
132 spu_write_wait();
133 local_irq_save(flags);
134 writel(regval, ARM_RESET_REGISTER);
135 local_irq_restore(flags);
136 for (i = 0; i < 64; i++) {
137 spu_write_wait();
138 regval = readl(SPU_REGISTER_BASE + (i * 0x80));
139 regval = (regval & ~0x4000) | 0x8000;
140 spu_write_wait();
141 local_irq_save(flags);
142 writel(regval, SPU_REGISTER_BASE + (i * 0x80));
143 local_irq_restore(flags);
144 }
145}
146
147/* spu_enable - set spu registers to enable sound output */
148static void spu_enable(void)
149{
150 unsigned long flags;
151 u32 regval = readl(ARM_RESET_REGISTER);
152 regval &= ~1;
153 spu_write_wait();
154 local_irq_save(flags);
155 writel(regval, ARM_RESET_REGISTER);
156 local_irq_restore(flags);
157}
158
159/*
160 * Halt the sound processor, clear the memory,
161 * load some default ARM7 code, and then restart ARM7
162*/
163static void spu_reset(void)
164{
165 unsigned long flags;
166 spu_disable();
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);
172 spu_enable();
173}
174
175/* aica_chn_start - write to spu to start playback */
176static void aica_chn_start(void)
177{
178 unsigned long flags;
179 spu_write_wait();
180 local_irq_save(flags);
181 writel(AICA_CMD_KICK | AICA_CMD_START, (u32 *) AICA_CONTROL_POINT);
182 local_irq_restore(flags);
183}
184
185/* aica_chn_halt - write to spu to halt playback */
186static void aica_chn_halt(void)
187{
188 unsigned long flags;
189 spu_write_wait();
190 local_irq_save(flags);
191 writel(AICA_CMD_KICK | AICA_CMD_STOP, (u32 *) AICA_CONTROL_POINT);
192 local_irq_restore(flags);
193}
194
195/* ALSA code below */
196static const struct snd_pcm_hardware snd_pcm_aica_playback_hw = {
197 .info = (SNDRV_PCM_INFO_NONINTERLEAVED),
198 .formats =
199 (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |
200 SNDRV_PCM_FMTBIT_IMA_ADPCM),
201 .rates = SNDRV_PCM_RATE_8000_48000,
202 .rate_min = 8000,
203 .rate_max = 48000,
204 .channels_min = 1,
205 .channels_max = 2,
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,
211};
212
213static int aica_dma_transfer(int channels, int buffer_size,
214 struct snd_pcm_substream *substream)
215{
216 int q, err, period_offset;
217 struct snd_card_aica *dreamcastcard;
218 struct snd_pcm_runtime *runtime;
219 unsigned long flags;
220 err = 0;
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) /
230 channels +
231 AICA_PERIOD_SIZE *
232 period_offset),
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);
238 break;
239 }
240 dma_wait_for_completion(AICA_DMA_CHANNEL);
241 local_irq_restore(flags);
242 }
243 return err;
244}
245
246static void startup_aica(struct snd_card_aica *dreamcastcard)
247{
248 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
249 dreamcastcard->channel, sizeof(struct aica_channel));
250 aica_chn_start();
251}
252
253static void run_spu_dma(struct work_struct *work)
254{
255 int buffer_size;
256 struct snd_pcm_runtime *runtime;
257 struct snd_card_aica *dreamcastcard;
258 dreamcastcard =
259 container_of(work, struct snd_card_aica, spu_dma_work);
260 runtime = dreamcastcard->substream->runtime;
261 if (unlikely(dreamcastcard->dma_check == 0)) {
262 buffer_size =
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);
271 return;
272 } else {
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);
282 }
283}
284
285static void aica_period_elapsed(struct timer_list *t)
286{
287 struct snd_card_aica *dreamcastcard = from_timer(dreamcastcard,
288 t, timer);
289 struct snd_pcm_substream *substream = dreamcastcard->substream;
290 /*timer function - so cannot sleep */
291 int play_period;
292 struct snd_pcm_runtime *runtime;
293 if (!snd_pcm_running(substream))
294 return;
295 runtime = substream->runtime;
296 dreamcastcard = substream->pcm->private_data;
297 /* Have we played out an additional period? */
298 play_period =
299 frames_to_bytes(runtime,
300 readl
301 (AICA_CONTROL_CHANNEL_SAMPLE_NUMBER)) /
302 AICA_PERIOD_SIZE;
303 if (play_period == dreamcastcard->current_period) {
304 /* reschedule the timer */
305 mod_timer(&(dreamcastcard->timer), jiffies + 1);
306 return;
307 }
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));
313}
314
315static void spu_begin_dma(struct snd_pcm_substream *substream)
316{
317 struct snd_card_aica *dreamcastcard;
318 dreamcastcard = substream->pcm->private_data;
319 /*get the queue to do the work */
320 schedule_work(&(dreamcastcard->spu_dma_work));
321 mod_timer(&dreamcastcard->timer, jiffies + 4);
322}
323
324static int snd_aicapcm_pcm_open(struct snd_pcm_substream
325 *substream)
326{
327 struct snd_pcm_runtime *runtime;
328 struct aica_channel *channel;
329 struct snd_card_aica *dreamcastcard;
330 if (!enable)
331 return -ENOENT;
332 dreamcastcard = substream->pcm->private_data;
333 channel = kmalloc(sizeof(struct aica_channel), GFP_KERNEL);
334 if (!channel)
335 return -ENOMEM;
336 /* set defaults for channel */
337 channel->sfmt = SM_8BIT;
338 channel->cmd = AICA_CMD_START;
339 channel->vol = dreamcastcard->master_volume;
340 channel->pan = 0x80;
341 channel->pos = 0;
342 channel->flags = 0; /* default to mono */
343 dreamcastcard->channel = channel;
344 runtime = substream->runtime;
345 runtime->hw = snd_pcm_aica_playback_hw;
346 spu_enable();
347 dreamcastcard->clicks = 0;
348 dreamcastcard->current_period = 0;
349 dreamcastcard->dma_check = 0;
350 return 0;
351}
352
353static int snd_aicapcm_pcm_sync_stop(struct snd_pcm_substream *substream)
354{
355 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
356
357 del_timer_sync(&dreamcastcard->timer);
358 cancel_work_sync(&dreamcastcard->spu_dma_work);
359 return 0;
360}
361
362static int snd_aicapcm_pcm_close(struct snd_pcm_substream
363 *substream)
364{
365 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
366 dreamcastcard->substream = NULL;
367 kfree(dreamcastcard->channel);
368 spu_disable();
369 return 0;
370}
371
372static int snd_aicapcm_pcm_prepare(struct snd_pcm_substream
373 *substream)
374{
375 struct snd_card_aica *dreamcastcard = substream->pcm->private_data;
376 if ((substream->runtime)->format == SNDRV_PCM_FORMAT_S16_LE)
377 dreamcastcard->channel->sfmt = SM_16BIT;
378 dreamcastcard->channel->freq = substream->runtime->rate;
379 dreamcastcard->substream = substream;
380 return 0;
381}
382
383static int snd_aicapcm_pcm_trigger(struct snd_pcm_substream
384 *substream, int cmd)
385{
386 switch (cmd) {
387 case SNDRV_PCM_TRIGGER_START:
388 spu_begin_dma(substream);
389 break;
390 case SNDRV_PCM_TRIGGER_STOP:
391 aica_chn_halt();
392 break;
393 default:
394 return -EINVAL;
395 }
396 return 0;
397}
398
399static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream
400 *substream)
401{
402 return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER);
403}
404
405static const struct snd_pcm_ops snd_aicapcm_playback_ops = {
406 .open = snd_aicapcm_pcm_open,
407 .close = snd_aicapcm_pcm_close,
408 .prepare = snd_aicapcm_pcm_prepare,
409 .trigger = snd_aicapcm_pcm_trigger,
410 .pointer = snd_aicapcm_pcm_pointer,
411 .sync_stop = snd_aicapcm_pcm_sync_stop,
412};
413
414/* TO DO: set up to handle more than one pcm instance */
415static int __init snd_aicapcmchip(struct snd_card_aica
416 *dreamcastcard, int pcm_index)
417{
418 struct snd_pcm *pcm;
419 int err;
420 /* AICA has no capture ability */
421 err =
422 snd_pcm_new(dreamcastcard->card, "AICA PCM", pcm_index, 1, 0,
423 &pcm);
424 if (unlikely(err < 0))
425 return err;
426 pcm->private_data = dreamcastcard;
427 strcpy(pcm->name, "AICA PCM");
428 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
429 &snd_aicapcm_playback_ops);
430 /* Allocate the DMA buffers */
431 snd_pcm_set_managed_buffer_all(pcm,
432 SNDRV_DMA_TYPE_CONTINUOUS,
433 NULL,
434 AICA_BUFFER_SIZE,
435 AICA_BUFFER_SIZE);
436 return 0;
437}
438
439/* Mixer controls */
440#define aica_pcmswitch_info snd_ctl_boolean_mono_info
441
442static int aica_pcmswitch_get(struct snd_kcontrol *kcontrol,
443 struct snd_ctl_elem_value *ucontrol)
444{
445 ucontrol->value.integer.value[0] = 1; /* TO DO: Fix me */
446 return 0;
447}
448
449static int aica_pcmswitch_put(struct snd_kcontrol *kcontrol,
450 struct snd_ctl_elem_value *ucontrol)
451{
452 if (ucontrol->value.integer.value[0] == 1)
453 return 0; /* TO DO: Fix me */
454 else
455 aica_chn_halt();
456 return 0;
457}
458
459static int aica_pcmvolume_info(struct snd_kcontrol *kcontrol,
460 struct snd_ctl_elem_info *uinfo)
461{
462 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
463 uinfo->count = 1;
464 uinfo->value.integer.min = 0;
465 uinfo->value.integer.max = 0xFF;
466 return 0;
467}
468
469static int aica_pcmvolume_get(struct snd_kcontrol *kcontrol,
470 struct snd_ctl_elem_value *ucontrol)
471{
472 struct snd_card_aica *dreamcastcard;
473 dreamcastcard = kcontrol->private_data;
474 if (unlikely(!dreamcastcard->channel))
475 return -ETXTBSY; /* we've not yet been set up */
476 ucontrol->value.integer.value[0] = dreamcastcard->channel->vol;
477 return 0;
478}
479
480static int aica_pcmvolume_put(struct snd_kcontrol *kcontrol,
481 struct snd_ctl_elem_value *ucontrol)
482{
483 struct snd_card_aica *dreamcastcard;
484 unsigned int vol;
485 dreamcastcard = kcontrol->private_data;
486 if (unlikely(!dreamcastcard->channel))
487 return -ETXTBSY;
488 vol = ucontrol->value.integer.value[0];
489 if (vol > 0xff)
490 return -EINVAL;
491 if (unlikely(dreamcastcard->channel->vol == vol))
492 return 0;
493 dreamcastcard->channel->vol = ucontrol->value.integer.value[0];
494 dreamcastcard->master_volume = ucontrol->value.integer.value[0];
495 spu_memload(AICA_CHANNEL0_CONTROL_OFFSET,
496 dreamcastcard->channel, sizeof(struct aica_channel));
497 return 1;
498}
499
500static const struct snd_kcontrol_new snd_aica_pcmswitch_control = {
501 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
502 .name = "PCM Playback Switch",
503 .index = 0,
504 .info = aica_pcmswitch_info,
505 .get = aica_pcmswitch_get,
506 .put = aica_pcmswitch_put
507};
508
509static const struct snd_kcontrol_new snd_aica_pcmvolume_control = {
510 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
511 .name = "PCM Playback Volume",
512 .index = 0,
513 .info = aica_pcmvolume_info,
514 .get = aica_pcmvolume_get,
515 .put = aica_pcmvolume_put
516};
517
518static int load_aica_firmware(void)
519{
520 int err;
521 const struct firmware *fw_entry;
522 spu_reset();
523 err = request_firmware(&fw_entry, "aica_firmware.bin", &pd->dev);
524 if (unlikely(err))
525 return err;
526 /* write firmware into memory */
527 spu_disable();
528 spu_memload(0, fw_entry->data, fw_entry->size);
529 spu_enable();
530 release_firmware(fw_entry);
531 return err;
532}
533
534static int add_aicamixer_controls(struct snd_card_aica *dreamcastcard)
535{
536 int err;
537 err = snd_ctl_add
538 (dreamcastcard->card,
539 snd_ctl_new1(&snd_aica_pcmvolume_control, dreamcastcard));
540 if (unlikely(err < 0))
541 return err;
542 err = snd_ctl_add
543 (dreamcastcard->card,
544 snd_ctl_new1(&snd_aica_pcmswitch_control, dreamcastcard));
545 if (unlikely(err < 0))
546 return err;
547 return 0;
548}
549
550static void snd_aica_remove(struct platform_device *devptr)
551{
552 struct snd_card_aica *dreamcastcard;
553 dreamcastcard = platform_get_drvdata(devptr);
554 snd_card_free(dreamcastcard->card);
555 kfree(dreamcastcard);
556}
557
558static int snd_aica_probe(struct platform_device *devptr)
559{
560 int err;
561 struct snd_card_aica *dreamcastcard;
562 dreamcastcard = kzalloc(sizeof(struct snd_card_aica), GFP_KERNEL);
563 if (unlikely(!dreamcastcard))
564 return -ENOMEM;
565 err = snd_card_new(&devptr->dev, index, SND_AICA_DRIVER,
566 THIS_MODULE, 0, &dreamcastcard->card);
567 if (unlikely(err < 0)) {
568 kfree(dreamcastcard);
569 return err;
570 }
571 strcpy(dreamcastcard->card->driver, "snd_aica");
572 strcpy(dreamcastcard->card->shortname, SND_AICA_DRIVER);
573 strcpy(dreamcastcard->card->longname,
574 "Yamaha AICA Super Intelligent Sound Processor for SEGA Dreamcast");
575 /* Prepare to use the queue */
576 INIT_WORK(&(dreamcastcard->spu_dma_work), run_spu_dma);
577 timer_setup(&dreamcastcard->timer, aica_period_elapsed, 0);
578 /* Load the PCM 'chip' */
579 err = snd_aicapcmchip(dreamcastcard, 0);
580 if (unlikely(err < 0))
581 goto freedreamcast;
582 /* Add basic controls */
583 err = add_aicamixer_controls(dreamcastcard);
584 if (unlikely(err < 0))
585 goto freedreamcast;
586 /* Register the card with ALSA subsystem */
587 err = snd_card_register(dreamcastcard->card);
588 if (unlikely(err < 0))
589 goto freedreamcast;
590 platform_set_drvdata(devptr, dreamcastcard);
591 dev_info(&devptr->dev,
592 "ALSA Driver for Yamaha AICA Super Intelligent Sound Processor\n");
593 return 0;
594 freedreamcast:
595 snd_card_free(dreamcastcard->card);
596 kfree(dreamcastcard);
597 return err;
598}
599
600static struct platform_driver snd_aica_driver = {
601 .probe = snd_aica_probe,
602 .remove = snd_aica_remove,
603 .driver = {
604 .name = SND_AICA_DRIVER,
605 },
606};
607
608static int __init aica_init(void)
609{
610 int err;
611 err = platform_driver_register(&snd_aica_driver);
612 if (unlikely(err < 0))
613 return err;
614 pd = platform_device_register_simple(SND_AICA_DRIVER, -1,
615 aica_memory_space, 2);
616 if (IS_ERR(pd)) {
617 platform_driver_unregister(&snd_aica_driver);
618 return PTR_ERR(pd);
619 }
620 /* Load the firmware */
621 return load_aica_firmware();
622}
623
624static void __exit aica_exit(void)
625{
626 platform_device_unregister(pd);
627 platform_driver_unregister(&snd_aica_driver);
628 /* Kill any sound still playing and reset ARM7 to safe state */
629 spu_reset();
630}
631
632module_init(aica_init);
633module_exit(aica_exit);