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_FIRMWARE("aica_firmware.bin"); 36 37 /* module parameters */ 38 #define CARD_NAME "AICA" 39 static int index = -1; 40 static char *id; 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."); 48 49 /* Simple platform device */ 50 static struct platform_device *pd; 51 static 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 */ 68 static 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 */ 85 static 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 */ 102 static 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 */ 124 static 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 */ 148 static 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 */ 163 static 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 */ 176 static 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 */ 186 static 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 */ 196 static 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 213 static 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 246 static 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 253 static 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 285 static 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 315 static 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 324 static 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 353 static 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 362 static 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 372 static 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 383 static 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 399 static unsigned long snd_aicapcm_pcm_pointer(struct snd_pcm_substream 400 *substream) 401 { 402 return readl(AICA_CONTROL_CHANNEL_SAMPLE_NUMBER); 403 } 404 405 static 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 */ 415 static 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 442 static 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 449 static 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 459 static 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 469 static 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 480 static 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 500 static 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 509 static 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 518 static 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 534 static 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 550 static 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 558 static 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 600 static 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 608 static 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 624 static 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 632 module_init(aica_init); 633 module_exit(aica_exit); 634