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