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