sound/sh/aica.c

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