sound/isa/gus/gus_main.c

   1 /*
   2  *  Routines for Gravis UltraSound soundcards
   3  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
   4  *
   5  *
   6  *   This program is free software; you can redistribute it and/or modify
   7  *   it under the terms of the GNU General Public License as published by
   8  *   the Free Software Foundation; either version 2 of the License, or
   9  *   (at your option) any later version.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program; if not, write to the Free Software
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19  *
  20  */
  21
  22 #include <sound/driver.h>
  23 #include <linux/init.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/delay.h>
  26 #include <linux/slab.h>
  27 #include <linux/ioport.h>
  28 #include <sound/core.h>
  29 #include <sound/gus.h>
  30 #include <sound/control.h>
  31
  32 #include <asm/dma.h>
  33
  34 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
  35 MODULE_DESCRIPTION("Routines for Gravis UltraSound soundcards");
  36 MODULE_LICENSE("GPL");
  37
  38 #define chip_t snd_gus_card_t
  39
  40 static int snd_gus_init_dma_irq(snd_gus_card_t * gus, int latches);
  41
  42 int snd_gus_use_inc(snd_gus_card_t * gus)
  43 {
  44         if (!try_module_get(gus->card->module))
  45                 return 0;
  46         return 1;
  47 }
  48
  49 void snd_gus_use_dec(snd_gus_card_t * gus)
  50 {
  51         module_put(gus->card->module);
  52 }
  53
  54 static int snd_gus_joystick_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
  55 {
  56         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
  57         uinfo->count = 1;
  58         uinfo->value.integer.min = 0;
  59         uinfo->value.integer.max = 31;
  60         return 0;
  61 }
  62
  63 static int snd_gus_joystick_get(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
  64 {
  65         snd_gus_card_t *gus = snd_kcontrol_chip(kcontrol);
  66
  67         ucontrol->value.integer.value[0] = gus->joystick_dac & 31;
  68         return 0;
  69 }
  70
  71 static int snd_gus_joystick_put(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
  72 {
  73         snd_gus_card_t *gus = snd_kcontrol_chip(kcontrol);
  74         unsigned long flags;
  75         int change;
  76         unsigned char nval;
  77
  78         nval = ucontrol->value.integer.value[0] & 31;
  79         spin_lock_irqsave(&gus->reg_lock, flags);
  80         change = gus->joystick_dac != nval;
  81         gus->joystick_dac = nval;
  82         snd_gf1_write8(gus, SNDRV_GF1_GB_JOYSTICK_DAC_LEVEL, gus->joystick_dac);
  83         spin_unlock_irqrestore(&gus->reg_lock, flags);
  84         return change;
  85 }
  86
  87 static snd_kcontrol_new_t snd_gus_joystick_control = {
  88         .iface = SNDRV_CTL_ELEM_IFACE_CARD,
  89         .name = "Joystick Speed",
  90         .info = snd_gus_joystick_info,
  91         .get = snd_gus_joystick_get,
  92         .put = snd_gus_joystick_put
  93 };
  94
  95 static void snd_gus_init_control(snd_gus_card_t *gus)
  96 {
  97         if (!gus->ace_flag)
  98                 snd_ctl_add(gus->card, snd_ctl_new1(&snd_gus_joystick_control, gus));
  99 }
 100
 101 /*
 102  *
 103  */
 104
 105 static int snd_gus_free(snd_gus_card_t *gus)
 106 {
 107         if (gus->gf1.res_port2 == NULL)
 108                 goto __hw_end;
 109 #if defined(CONFIG_SND_SEQUENCER) || (defined(MODULE) && defined(CONFIG_SND_SEQUENCER_MODULE))
 110         if (gus->seq_dev) {
 111                 snd_device_free(gus->card, gus->seq_dev);
 112                 gus->seq_dev = NULL;
 113         }
 114 #endif
 115         snd_gf1_stop(gus);
 116         snd_gus_init_dma_irq(gus, 0);
 117       __hw_end:
 118         if (gus->gf1.res_port1) {
 119                 release_resource(gus->gf1.res_port1);
 120                 kfree_nocheck(gus->gf1.res_port1);
 121         }
 122         if (gus->gf1.res_port2) {
 123                 release_resource(gus->gf1.res_port2);
 124                 kfree_nocheck(gus->gf1.res_port2);
 125         }
 126         if (gus->gf1.irq >= 0)
 127                 free_irq(gus->gf1.irq, (void *) gus);
 128         if (gus->gf1.dma1 >= 0) {
 129                 disable_dma(gus->gf1.dma1);
 130                 free_dma(gus->gf1.dma1);
 131         }
 132         if (!gus->equal_dma && gus->gf1.dma2 >= 0) {
 133                 disable_dma(gus->gf1.dma2);
 134                 free_dma(gus->gf1.dma2);
 135         }
 136         snd_magic_kfree(gus);
 137         return 0;
 138 }
 139
 140 static int snd_gus_dev_free(snd_device_t *device)
 141 {
 142         snd_gus_card_t *gus = snd_magic_cast(snd_gus_card_t, device->device_data, return -ENXIO);
 143         return snd_gus_free(gus);
 144 }
 145
 146 int snd_gus_create(snd_card_t * card,
 147                    unsigned long port,
 148                    int irq, int dma1, int dma2,
 149                    int timer_dev,
 150                    int voices,
 151                    int pcm_channels,
 152                    int effect,
 153                    snd_gus_card_t **rgus)
 154 {
 155         snd_gus_card_t *gus;
 156         int err;
 157         static snd_device_ops_t ops = {
 158                 .dev_free =     snd_gus_dev_free,
 159         };
 160
 161         *rgus = NULL;
 162         gus = snd_magic_kcalloc(snd_gus_card_t, 0, GFP_KERNEL);
 163         if (gus == NULL)
 164                 return -ENOMEM;
 165         gus->gf1.irq = -1;
 166         gus->gf1.dma1 = -1;
 167         gus->gf1.dma2 = -1;
 168         gus->card = card;
 169         gus->gf1.port = port;
 170         /* fill register variables for speedup */
 171         gus->gf1.reg_page = GUSP(gus, GF1PAGE);
 172         gus->gf1.reg_regsel = GUSP(gus, GF1REGSEL);
 173         gus->gf1.reg_data8 = GUSP(gus, GF1DATAHIGH);
 174         gus->gf1.reg_data16 = GUSP(gus, GF1DATALOW);
 175         gus->gf1.reg_irqstat = GUSP(gus, IRQSTAT);
 176         gus->gf1.reg_dram = GUSP(gus, DRAM);
 177         gus->gf1.reg_timerctrl = GUSP(gus, TIMERCNTRL);
 178         gus->gf1.reg_timerdata = GUSP(gus, TIMERDATA);
 179         /* allocate resources */
 180         if ((gus->gf1.res_port1 = request_region(port, 16, "GUS GF1 (Adlib/SB)")) == NULL) {
 181                 snd_printk(KERN_ERR "gus: can't grab SB port 0x%lx\n", port);
 182                 snd_gus_free(gus);
 183                 return -EBUSY;
 184         }
 185         if ((gus->gf1.res_port2 = request_region(port + 0x100, 12, "GUS GF1 (Synth)")) == NULL) {
 186                 snd_printk(KERN_ERR "gus: can't grab synth port 0x%lx\n", port + 0x100);
 187                 snd_gus_free(gus);
 188                 return -EBUSY;
 189         }
 190         if (irq >= 0 && request_irq(irq, snd_gus_interrupt, SA_INTERRUPT, "GUS GF1", (void *) gus)) {
 191                 snd_printk(KERN_ERR "gus: can't grab irq %d\n", irq);
 192                 snd_gus_free(gus);
 193                 return -EBUSY;
 194         }
 195         gus->gf1.irq = irq;
 196         if (request_dma(dma1, "GUS - 1")) {
 197                 snd_printk(KERN_ERR "gus: can't grab DMA1 %d\n", dma1);
 198                 snd_gus_free(gus);
 199                 return -EBUSY;
 200         }
 201         gus->gf1.dma1 = dma1;
 202         if (dma2 >= 0 && dma1 != dma2) {
 203                 if (request_dma(dma2, "GUS - 2")) {
 204                         snd_printk(KERN_ERR "gus: can't grab DMA2 %d\n", dma2);
 205                         snd_gus_free(gus);
 206                         return -EBUSY;
 207                 }
 208                 gus->gf1.dma2 = dma2;
 209         } else {
 210                 gus->gf1.dma2 = gus->gf1.dma1;
 211                 gus->equal_dma = 1;
 212         }
 213         gus->timer_dev = timer_dev;
 214         if (voices < 14)
 215                 voices = 14;
 216         if (voices > 32)
 217                 voices = 32;
 218         if (pcm_channels < 0)
 219                 pcm_channels = 0;
 220         if (pcm_channels > 8)
 221                 pcm_channels = 8;
 222         pcm_channels++;
 223         pcm_channels &= ~1;
 224         gus->gf1.effect = effect ? 1 : 0;
 225         gus->gf1.active_voices = voices;
 226         gus->gf1.pcm_channels = pcm_channels;
 227         gus->gf1.volume_ramp = 25;
 228         gus->gf1.smooth_pan = 1;
 229         spin_lock_init(&gus->reg_lock);
 230         spin_lock_init(&gus->voice_alloc);
 231         spin_lock_init(&gus->active_voice_lock);
 232         spin_lock_init(&gus->event_lock);
 233         spin_lock_init(&gus->dma_lock);
 234         spin_lock_init(&gus->pcm_volume_level_lock);
 235         spin_lock_init(&gus->uart_cmd_lock);
 236         init_MUTEX(&gus->dma_mutex);
 237         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, gus, &ops)) < 0) {
 238                 snd_gus_free(gus);
 239                 return err;
 240         }
 241         *rgus = gus;
 242         return 0;
 243 }
 244
 245 /*
 246  *  Memory detection routine for plain GF1 soundcards
 247  */
 248
 249 static int snd_gus_detect_memory(snd_gus_card_t * gus)
 250 {
 251         int l, idx, local;
 252         unsigned char d;
 253
 254         snd_gf1_poke(gus, 0L, 0xaa);
 255         snd_gf1_poke(gus, 1L, 0x55);
 256         if (snd_gf1_peek(gus, 0L) != 0xaa || snd_gf1_peek(gus, 1L) != 0x55) {
 257                 snd_printk("plain GF1 card at 0x%lx without onboard DRAM?\n", gus->gf1.port);
 258                 return -ENOMEM;
 259         }
 260         for (idx = 1, d = 0xab; idx < 4; idx++, d++) {
 261                 local = idx << 18;
 262                 snd_gf1_poke(gus, local, d);
 263                 snd_gf1_poke(gus, local + 1, d + 1);
 264                 if (snd_gf1_peek(gus, local) != d ||
 265                     snd_gf1_peek(gus, local + 1) != d + 1 ||
 266                     snd_gf1_peek(gus, 0L) != 0xaa)
 267                         break;
 268         }
 269 #if 1
 270         gus->gf1.memory = idx << 18;
 271 #else
 272         gus->gf1.memory = 256 * 1024;
 273 #endif
 274         for (l = 0, local = gus->gf1.memory; l < 4; l++, local -= 256 * 1024) {
 275                 gus->gf1.mem_alloc.banks_8[l].address =
 276                     gus->gf1.mem_alloc.banks_8[l].size = 0;
 277                 gus->gf1.mem_alloc.banks_16[l].address = l << 18;
 278                 gus->gf1.mem_alloc.banks_16[l].size = local > 0 ? 256 * 1024 : 0;
 279         }
 280         gus->gf1.mem_alloc.banks_8[0].size = gus->gf1.memory;
 281         return 0;               /* some memory were detected */
 282 }
 283
 284 static int snd_gus_init_dma_irq(snd_gus_card_t * gus, int latches)
 285 {
 286         snd_card_t *card;
 287         unsigned long flags;
 288         int irq, dma1, dma2;
 289         static unsigned char irqs[16] =
 290                 {0, 0, 1, 3, 0, 2, 0, 4, 0, 1, 0, 5, 6, 0, 0, 7};
 291         static unsigned char dmas[8] =
 292                 {6, 1, 0, 2, 0, 3, 4, 5};
 293
 294         snd_assert(gus != NULL, return -EINVAL);
 295         card = gus->card;
 296         snd_assert(card != NULL, return -EINVAL);
 297
 298         gus->mix_cntrl_reg &= 0xf8;
 299         gus->mix_cntrl_reg |= 0x01;     /* disable MIC, LINE IN, enable LINE OUT */
 300         if (gus->codec_flag || gus->ess_flag) {
 301                 gus->mix_cntrl_reg &= ~1;       /* enable LINE IN */
 302                 gus->mix_cntrl_reg |= 4;        /* enable MIC */
 303         }
 304         dma1 = gus->gf1.dma1;
 305         dma1 = dma1 < 0 ? -dma1 : dma1;
 306         dma1 = dmas[dma1 & 7];
 307         dma2 = gus->gf1.dma2;
 308         dma2 = dma2 < 0 ? -dma2 : dma2;
 309         dma2 = dmas[dma2 & 7];
 310 #if 0
 311         printk("dma1 = %i, dma2 = %i\n", gus->gf1.dma1, gus->gf1.dma2);
 312 #endif
 313         dma1 |= gus->equal_dma ? 0x40 : (dma2 << 3);
 314
 315         if ((dma1 & 7) == 0 || (dma2 & 7) == 0) {
 316                 snd_printk("Error! DMA isn't defined.\n");
 317                 return -EINVAL;
 318         }
 319         irq = gus->gf1.irq;
 320         irq = irq < 0 ? -irq : irq;
 321         irq = irqs[irq & 0x0f];
 322         if (irq == 0) {
 323                 snd_printk("Error! IRQ isn't defined.\n");
 324                 return -EINVAL;
 325         }
 326         irq |= 0x40;
 327 #if 0
 328         card->mixer.mix_ctrl_reg |= 0x10;
 329 #endif
 330
 331         spin_lock_irqsave(&gus->reg_lock, flags);
 332         outb(5, GUSP(gus, REGCNTRLS));
 333         outb(gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 334         outb(0x00, GUSP(gus, IRQDMACNTRLREG));
 335         outb(0, GUSP(gus, REGCNTRLS));
 336         spin_unlock_irqrestore(&gus->reg_lock, flags);
 337
 338         udelay(100);
 339
 340         spin_lock_irqsave(&gus->reg_lock, flags);
 341         outb(0x00 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 342         outb(dma1, GUSP(gus, IRQDMACNTRLREG));
 343         if (latches) {
 344                 outb(0x40 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 345                 outb(irq, GUSP(gus, IRQDMACNTRLREG));
 346         }
 347         spin_unlock_irqrestore(&gus->reg_lock, flags);
 348
 349         udelay(100);
 350
 351         spin_lock_irqsave(&gus->reg_lock, flags);
 352         outb(0x00 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 353         outb(dma1, GUSP(gus, IRQDMACNTRLREG));
 354         if (latches) {
 355                 outb(0x40 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 356                 outb(irq, GUSP(gus, IRQDMACNTRLREG));
 357         }
 358         spin_unlock_irqrestore(&gus->reg_lock, flags);
 359
 360         snd_gf1_delay(gus);
 361
 362         if (latches)
 363                 gus->mix_cntrl_reg |= 0x08;     /* enable latches */
 364         else
 365                 gus->mix_cntrl_reg &= ~0x08;    /* disable latches */
 366         spin_lock_irqsave(&gus->reg_lock, flags);
 367         outb(gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 368         outb(0, GUSP(gus, GF1PAGE));
 369         spin_unlock_irqrestore(&gus->reg_lock, flags);
 370
 371         return 0;
 372 }
 373
 374 static int snd_gus_check_version(snd_gus_card_t * gus)
 375 {
 376         unsigned long flags;
 377         unsigned char val, rev;
 378         snd_card_t *card;
 379
 380         card = gus->card;
 381         spin_lock_irqsave(&gus->reg_lock, flags);
 382         outb(0x20, GUSP(gus, REGCNTRLS));
 383         val = inb(GUSP(gus, REGCNTRLS));
 384         rev = inb(GUSP(gus, BOARDVERSION));
 385         spin_unlock_irqrestore(&gus->reg_lock, flags);
 386         snd_printdd("GF1 [0x%lx] init - val = 0x%x, rev = 0x%x\n", gus->gf1.port, val, rev);
 387         strcpy(card->driver, "GUS");
 388         strcpy(card->longname, "Gravis UltraSound Classic (2.4)");
 389         if ((val != 255 && (val & 0x06)) || (rev >= 5 && rev != 255)) {
 390                 if (rev >= 5 && rev <= 9) {
 391                         gus->ics_flag = 1;
 392                         if (rev == 5)
 393                                 gus->ics_flipped = 1;
 394                         card->longname[27] = '3';
 395                         card->longname[29] = rev == 5 ? '5' : '7';
 396                 }
 397                 if (rev >= 10 && rev != 255) {
 398                         if (rev >= 10 && rev <= 11) {
 399                                 strcpy(card->driver, "GUS MAX");
 400                                 strcpy(card->longname, "Gravis UltraSound MAX");
 401                                 gus->max_flag = 1;
 402                         } else if (rev == 0x30) {
 403                                 strcpy(card->driver, "GUS ACE");
 404                                 strcpy(card->longname, "Gravis UltraSound Ace");
 405                                 gus->ace_flag = 1;
 406                         } else if (rev == 0x50) {
 407                                 strcpy(card->driver, "GUS Extreme");
 408                                 strcpy(card->longname, "Gravis UltraSound Extreme");
 409                                 gus->ess_flag = 1;
 410                         } else {
 411                                 snd_printk("unknown GF1 revision number at 0x%lx - 0x%x (0x%x)\n", gus->gf1.port, rev, val);
 412                                 snd_printk("  please - report to <perex@suse.cz>\n");
 413                         }
 414                 }
 415         }
 416         strcpy(card->shortname, card->longname);
 417         gus->uart_enable = 1;   /* standard GUSes doesn't have midi uart trouble */
 418         snd_gus_init_control(gus);
 419         return 0;
 420 }
 421
 422 static void snd_gus_seq_dev_free(snd_seq_device_t *seq_dev)
 423 {
 424         snd_gus_card_t *gus = snd_magic_cast(snd_gus_card_t, seq_dev->private_data, return);
 425         gus->seq_dev = NULL;
 426 }
 427
 428 int snd_gus_initialize(snd_gus_card_t *gus)
 429 {
 430         int err;
 431
 432         if (!gus->interwave) {
 433                 if ((err = snd_gus_check_version(gus)) < 0) {
 434                         snd_printk("version check failed\n");
 435                         return err;
 436                 }
 437                 if ((err = snd_gus_detect_memory(gus)) < 0)
 438                         return err;
 439         }
 440         if ((err = snd_gus_init_dma_irq(gus, 1)) < 0)
 441                 return err;
 442 #if defined(CONFIG_SND_SEQUENCER) || (defined(MODULE) && defined(CONFIG_SND_SEQUENCER_MODULE))
 443         if (snd_seq_device_new(gus->card, 1, SNDRV_SEQ_DEV_ID_GUS,
 444                                sizeof(snd_gus_card_t*), &gus->seq_dev) >= 0) {
 445                 strcpy(gus->seq_dev->name, "GUS");
 446                 *(snd_gus_card_t**)SNDRV_SEQ_DEVICE_ARGPTR(gus->seq_dev) = gus;
 447                 gus->seq_dev->private_data = gus;
 448                 gus->seq_dev->private_free = snd_gus_seq_dev_free;
 449         }
 450 #endif
 451         snd_gf1_start(gus);
 452         gus->initialized = 1;
 453         return 0;
 454 }
 455
 456   /* gus_io.c */
 457 EXPORT_SYMBOL(snd_gf1_delay);
 458 EXPORT_SYMBOL(snd_gf1_write8);
 459 EXPORT_SYMBOL(snd_gf1_look8);
 460 EXPORT_SYMBOL(snd_gf1_write16);
 461 EXPORT_SYMBOL(snd_gf1_look16);
 462 EXPORT_SYMBOL(snd_gf1_i_write8);
 463 EXPORT_SYMBOL(snd_gf1_i_look8);
 464 EXPORT_SYMBOL(snd_gf1_i_write16);
 465 EXPORT_SYMBOL(snd_gf1_i_look16);
 466 EXPORT_SYMBOL(snd_gf1_dram_addr);
 467 EXPORT_SYMBOL(snd_gf1_write_addr);
 468 EXPORT_SYMBOL(snd_gf1_poke);
 469 EXPORT_SYMBOL(snd_gf1_peek);
 470   /* gus_reset.c */
 471 EXPORT_SYMBOL(snd_gf1_alloc_voice);
 472 EXPORT_SYMBOL(snd_gf1_free_voice);
 473 EXPORT_SYMBOL(snd_gf1_ctrl_stop);
 474 EXPORT_SYMBOL(snd_gf1_stop_voice);
 475 EXPORT_SYMBOL(snd_gf1_start);
 476 EXPORT_SYMBOL(snd_gf1_stop);
 477   /* gus_mixer.c */
 478 EXPORT_SYMBOL(snd_gf1_new_mixer);
 479   /* gus_pcm.c */
 480 EXPORT_SYMBOL(snd_gf1_pcm_new);
 481   /* gus.c */
 482 EXPORT_SYMBOL(snd_gus_use_inc);
 483 EXPORT_SYMBOL(snd_gus_use_dec);
 484 EXPORT_SYMBOL(snd_gus_create);
 485 EXPORT_SYMBOL(snd_gus_initialize);
 486   /* gus_irq.c */
 487 EXPORT_SYMBOL(snd_gus_interrupt);
 488   /* gus_uart.c */
 489 EXPORT_SYMBOL(snd_gf1_rawmidi_new);
 490   /* gus_dram.c */
 491 EXPORT_SYMBOL(snd_gus_dram_write);
 492 EXPORT_SYMBOL(snd_gus_dram_read);
 493   /* gus_volume.c */
 494 EXPORT_SYMBOL(snd_gf1_lvol_to_gvol_raw);
 495 EXPORT_SYMBOL(snd_gf1_translate_freq);
 496   /* gus_mem.c */
 497 EXPORT_SYMBOL(snd_gf1_mem_alloc);
 498 EXPORT_SYMBOL(snd_gf1_mem_xfree);
 499 EXPORT_SYMBOL(snd_gf1_mem_free);
 500 EXPORT_SYMBOL(snd_gf1_mem_lock);
 501
 502 /*
 503  *  INIT part
 504  */
 505
 506 static int __init alsa_gus_init(void)
 507 {
 508         return 0;
 509 }
 510
 511 static void __exit alsa_gus_exit(void)
 512 {
 513 }
 514
 515 module_init(alsa_gus_init)
 516 module_exit(alsa_gus_exit)