sound/isa/gus/gus_main.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  Routines for Gravis UltraSound soundcards
   4  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   5  */
   6
   7 #include <linux/init.h>
   8 #include <linux/interrupt.h>
   9 #include <linux/delay.h>
  10 #include <linux/slab.h>
  11 #include <linux/ioport.h>
  12 #include <linux/module.h>
  13 #include <sound/core.h>
  14 #include <sound/gus.h>
  15 #include <sound/control.h>
  16
  17 #include <asm/dma.h>
  18
  19 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
  20 MODULE_DESCRIPTION("Routines for Gravis UltraSound soundcards");
  21 MODULE_LICENSE("GPL");
  22
  23 static int snd_gus_init_dma_irq(struct snd_gus_card * gus, int latches);
  24
  25 int snd_gus_use_inc(struct snd_gus_card * gus)
  26 {
  27         if (!try_module_get(gus->card->module))
  28                 return 0;
  29         return 1;
  30 }
  31
  32 void snd_gus_use_dec(struct snd_gus_card * gus)
  33 {
  34         module_put(gus->card->module);
  35 }
  36
  37 static int snd_gus_joystick_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
  38 {
  39         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
  40         uinfo->count = 1;
  41         uinfo->value.integer.min = 0;
  42         uinfo->value.integer.max = 31;
  43         return 0;
  44 }
  45
  46 static int snd_gus_joystick_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
  47 {
  48         struct snd_gus_card *gus = snd_kcontrol_chip(kcontrol);
  49
  50         ucontrol->value.integer.value[0] = gus->joystick_dac & 31;
  51         return 0;
  52 }
  53
  54 static int snd_gus_joystick_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
  55 {
  56         struct snd_gus_card *gus = snd_kcontrol_chip(kcontrol);
  57         unsigned long flags;
  58         int change;
  59         unsigned char nval;
  60
  61         nval = ucontrol->value.integer.value[0] & 31;
  62         spin_lock_irqsave(&gus->reg_lock, flags);
  63         change = gus->joystick_dac != nval;
  64         gus->joystick_dac = nval;
  65         snd_gf1_write8(gus, SNDRV_GF1_GB_JOYSTICK_DAC_LEVEL, gus->joystick_dac);
  66         spin_unlock_irqrestore(&gus->reg_lock, flags);
  67         return change;
  68 }
  69
  70 static const struct snd_kcontrol_new snd_gus_joystick_control = {
  71         .iface = SNDRV_CTL_ELEM_IFACE_CARD,
  72         .name = "Joystick Speed",
  73         .info = snd_gus_joystick_info,
  74         .get = snd_gus_joystick_get,
  75         .put = snd_gus_joystick_put
  76 };
  77
  78 static void snd_gus_init_control(struct snd_gus_card *gus)
  79 {
  80         if (!gus->ace_flag)
  81                 snd_ctl_add(gus->card, snd_ctl_new1(&snd_gus_joystick_control, gus));
  82 }
  83
  84 /*
  85  *
  86  */
  87
  88 static int snd_gus_free(struct snd_gus_card *gus)
  89 {
  90         if (gus->gf1.res_port2) {
  91                 snd_gf1_stop(gus);
  92                 snd_gus_init_dma_irq(gus, 0);
  93         }
  94         return 0;
  95 }
  96
  97 static int snd_gus_dev_free(struct snd_device *device)
  98 {
  99         struct snd_gus_card *gus = device->device_data;
 100         return snd_gus_free(gus);
 101 }
 102
 103 int snd_gus_create(struct snd_card *card,
 104                    unsigned long port,
 105                    int irq, int dma1, int dma2,
 106                    int timer_dev,
 107                    int voices,
 108                    int pcm_channels,
 109                    int effect,
 110                    struct snd_gus_card **rgus)
 111 {
 112         struct snd_gus_card *gus;
 113         int err;
 114         static const struct snd_device_ops ops = {
 115                 .dev_free =     snd_gus_dev_free,
 116         };
 117
 118         *rgus = NULL;
 119         gus = devm_kzalloc(card->dev, sizeof(*gus), GFP_KERNEL);
 120         if (gus == NULL)
 121                 return -ENOMEM;
 122         spin_lock_init(&gus->reg_lock);
 123         spin_lock_init(&gus->voice_alloc);
 124         spin_lock_init(&gus->active_voice_lock);
 125         spin_lock_init(&gus->event_lock);
 126         spin_lock_init(&gus->dma_lock);
 127         spin_lock_init(&gus->pcm_volume_level_lock);
 128         spin_lock_init(&gus->uart_cmd_lock);
 129         mutex_init(&gus->dma_mutex);
 130         gus->gf1.irq = -1;
 131         gus->gf1.dma1 = -1;
 132         gus->gf1.dma2 = -1;
 133         gus->card = card;
 134         gus->gf1.port = port;
 135         /* fill register variables for speedup */
 136         gus->gf1.reg_page = GUSP(gus, GF1PAGE);
 137         gus->gf1.reg_regsel = GUSP(gus, GF1REGSEL);
 138         gus->gf1.reg_data8 = GUSP(gus, GF1DATAHIGH);
 139         gus->gf1.reg_data16 = GUSP(gus, GF1DATALOW);
 140         gus->gf1.reg_irqstat = GUSP(gus, IRQSTAT);
 141         gus->gf1.reg_dram = GUSP(gus, DRAM);
 142         gus->gf1.reg_timerctrl = GUSP(gus, TIMERCNTRL);
 143         gus->gf1.reg_timerdata = GUSP(gus, TIMERDATA);
 144         /* allocate resources */
 145         gus->gf1.res_port1 = devm_request_region(card->dev, port, 16,
 146                                                  "GUS GF1 (Adlib/SB)");
 147         if (!gus->gf1.res_port1) {
 148                 snd_printk(KERN_ERR "gus: can't grab SB port 0x%lx\n", port);
 149                 return -EBUSY;
 150         }
 151         gus->gf1.res_port2 = devm_request_region(card->dev, port + 0x100, 12,
 152                                                  "GUS GF1 (Synth)");
 153         if (!gus->gf1.res_port2) {
 154                 snd_printk(KERN_ERR "gus: can't grab synth port 0x%lx\n", port + 0x100);
 155                 return -EBUSY;
 156         }
 157         if (irq >= 0 && devm_request_irq(card->dev, irq, snd_gus_interrupt, 0,
 158                                          "GUS GF1", (void *) gus)) {
 159                 snd_printk(KERN_ERR "gus: can't grab irq %d\n", irq);
 160                 return -EBUSY;
 161         }
 162         gus->gf1.irq = irq;
 163         card->sync_irq = irq;
 164         if (snd_devm_request_dma(card->dev, dma1, "GUS - 1")) {
 165                 snd_printk(KERN_ERR "gus: can't grab DMA1 %d\n", dma1);
 166                 return -EBUSY;
 167         }
 168         gus->gf1.dma1 = dma1;
 169         if (dma2 >= 0 && dma1 != dma2) {
 170                 if (snd_devm_request_dma(card->dev, dma2, "GUS - 2")) {
 171                         snd_printk(KERN_ERR "gus: can't grab DMA2 %d\n", dma2);
 172                         return -EBUSY;
 173                 }
 174                 gus->gf1.dma2 = dma2;
 175         } else {
 176                 gus->gf1.dma2 = gus->gf1.dma1;
 177                 gus->equal_dma = 1;
 178         }
 179         gus->timer_dev = timer_dev;
 180         if (voices < 14)
 181                 voices = 14;
 182         if (voices > 32)
 183                 voices = 32;
 184         if (pcm_channels < 0)
 185                 pcm_channels = 0;
 186         if (pcm_channels > 8)
 187                 pcm_channels = 8;
 188         pcm_channels++;
 189         pcm_channels &= ~1;
 190         gus->gf1.effect = effect ? 1 : 0;
 191         gus->gf1.active_voices = voices;
 192         gus->gf1.pcm_channels = pcm_channels;
 193         gus->gf1.volume_ramp = 25;
 194         gus->gf1.smooth_pan = 1;
 195         err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, gus, &ops);
 196         if (err < 0)
 197                 return err;
 198         *rgus = gus;
 199         return 0;
 200 }
 201
 202 /*
 203  *  Memory detection routine for plain GF1 soundcards
 204  */
 205
 206 static int snd_gus_detect_memory(struct snd_gus_card * gus)
 207 {
 208         int l, idx, local;
 209         unsigned char d;
 210
 211         snd_gf1_poke(gus, 0L, 0xaa);
 212         snd_gf1_poke(gus, 1L, 0x55);
 213         if (snd_gf1_peek(gus, 0L) != 0xaa || snd_gf1_peek(gus, 1L) != 0x55) {
 214                 snd_printk(KERN_ERR "plain GF1 card at 0x%lx without onboard DRAM?\n", gus->gf1.port);
 215                 return -ENOMEM;
 216         }
 217         for (idx = 1, d = 0xab; idx < 4; idx++, d++) {
 218                 local = idx << 18;
 219                 snd_gf1_poke(gus, local, d);
 220                 snd_gf1_poke(gus, local + 1, d + 1);
 221                 if (snd_gf1_peek(gus, local) != d ||
 222                     snd_gf1_peek(gus, local + 1) != d + 1 ||
 223                     snd_gf1_peek(gus, 0L) != 0xaa)
 224                         break;
 225         }
 226 #if 1
 227         gus->gf1.memory = idx << 18;
 228 #else
 229         gus->gf1.memory = 256 * 1024;
 230 #endif
 231         for (l = 0, local = gus->gf1.memory; l < 4; l++, local -= 256 * 1024) {
 232                 gus->gf1.mem_alloc.banks_8[l].address =
 233                     gus->gf1.mem_alloc.banks_8[l].size = 0;
 234                 gus->gf1.mem_alloc.banks_16[l].address = l << 18;
 235                 gus->gf1.mem_alloc.banks_16[l].size = local > 0 ? 256 * 1024 : 0;
 236         }
 237         gus->gf1.mem_alloc.banks_8[0].size = gus->gf1.memory;
 238         return 0;               /* some memory were detected */
 239 }
 240
 241 static int snd_gus_init_dma_irq(struct snd_gus_card * gus, int latches)
 242 {
 243         struct snd_card *card;
 244         unsigned long flags;
 245         int irq, dma1, dma2;
 246         static const unsigned char irqs[16] =
 247                 {0, 0, 1, 3, 0, 2, 0, 4, 0, 1, 0, 5, 6, 0, 0, 7};
 248         static const unsigned char dmas[8] =
 249                 {6, 1, 0, 2, 0, 3, 4, 5};
 250
 251         if (snd_BUG_ON(!gus))
 252                 return -EINVAL;
 253         card = gus->card;
 254         if (snd_BUG_ON(!card))
 255                 return -EINVAL;
 256
 257         gus->mix_cntrl_reg &= 0xf8;
 258         gus->mix_cntrl_reg |= 0x01;     /* disable MIC, LINE IN, enable LINE OUT */
 259         if (gus->codec_flag || gus->ess_flag) {
 260                 gus->mix_cntrl_reg &= ~1;       /* enable LINE IN */
 261                 gus->mix_cntrl_reg |= 4;        /* enable MIC */
 262         }
 263         dma1 = gus->gf1.dma1;
 264         dma1 = abs(dma1);
 265         dma1 = dmas[dma1 & 7];
 266         dma2 = gus->gf1.dma2;
 267         dma2 = abs(dma2);
 268         dma2 = dmas[dma2 & 7];
 269         dma1 |= gus->equal_dma ? 0x40 : (dma2 << 3);
 270
 271         if ((dma1 & 7) == 0 || (dma2 & 7) == 0) {
 272                 snd_printk(KERN_ERR "Error! DMA isn't defined.\n");
 273                 return -EINVAL;
 274         }
 275         irq = gus->gf1.irq;
 276         irq = abs(irq);
 277         irq = irqs[irq & 0x0f];
 278         if (irq == 0) {
 279                 snd_printk(KERN_ERR "Error! IRQ isn't defined.\n");
 280                 return -EINVAL;
 281         }
 282         irq |= 0x40;
 283 #if 0
 284         card->mixer.mix_ctrl_reg |= 0x10;
 285 #endif
 286
 287         spin_lock_irqsave(&gus->reg_lock, flags);
 288         outb(5, GUSP(gus, REGCNTRLS));
 289         outb(gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 290         outb(0x00, GUSP(gus, IRQDMACNTRLREG));
 291         outb(0, GUSP(gus, REGCNTRLS));
 292         spin_unlock_irqrestore(&gus->reg_lock, flags);
 293
 294         udelay(100);
 295
 296         spin_lock_irqsave(&gus->reg_lock, flags);
 297         outb(0x00 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 298         outb(dma1, GUSP(gus, IRQDMACNTRLREG));
 299         if (latches) {
 300                 outb(0x40 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 301                 outb(irq, GUSP(gus, IRQDMACNTRLREG));
 302         }
 303         spin_unlock_irqrestore(&gus->reg_lock, flags);
 304
 305         udelay(100);
 306
 307         spin_lock_irqsave(&gus->reg_lock, flags);
 308         outb(0x00 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 309         outb(dma1, GUSP(gus, IRQDMACNTRLREG));
 310         if (latches) {
 311                 outb(0x40 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 312                 outb(irq, GUSP(gus, IRQDMACNTRLREG));
 313         }
 314         spin_unlock_irqrestore(&gus->reg_lock, flags);
 315
 316         snd_gf1_delay(gus);
 317
 318         if (latches)
 319                 gus->mix_cntrl_reg |= 0x08;     /* enable latches */
 320         else
 321                 gus->mix_cntrl_reg &= ~0x08;    /* disable latches */
 322         spin_lock_irqsave(&gus->reg_lock, flags);
 323         outb(gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
 324         outb(0, GUSP(gus, GF1PAGE));
 325         spin_unlock_irqrestore(&gus->reg_lock, flags);
 326
 327         return 0;
 328 }
 329
 330 static int snd_gus_check_version(struct snd_gus_card * gus)
 331 {
 332         unsigned long flags;
 333         unsigned char val, rev;
 334         struct snd_card *card;
 335
 336         card = gus->card;
 337         spin_lock_irqsave(&gus->reg_lock, flags);
 338         outb(0x20, GUSP(gus, REGCNTRLS));
 339         val = inb(GUSP(gus, REGCNTRLS));
 340         rev = inb(GUSP(gus, BOARDVERSION));
 341         spin_unlock_irqrestore(&gus->reg_lock, flags);
 342         snd_printdd("GF1 [0x%lx] init - val = 0x%x, rev = 0x%x\n", gus->gf1.port, val, rev);
 343         strcpy(card->driver, "GUS");
 344         strcpy(card->longname, "Gravis UltraSound Classic (2.4)");
 345         if ((val != 255 && (val & 0x06)) || (rev >= 5 && rev != 255)) {
 346                 if (rev >= 5 && rev <= 9) {
 347                         gus->ics_flag = 1;
 348                         if (rev == 5)
 349                                 gus->ics_flipped = 1;
 350                         card->longname[27] = '3';
 351                         card->longname[29] = rev == 5 ? '5' : '7';
 352                 }
 353                 if (rev >= 10 && rev != 255) {
 354                         if (rev >= 10 && rev <= 11) {
 355                                 strcpy(card->driver, "GUS MAX");
 356                                 strcpy(card->longname, "Gravis UltraSound MAX");
 357                                 gus->max_flag = 1;
 358                         } else if (rev == 0x30) {
 359                                 strcpy(card->driver, "GUS ACE");
 360                                 strcpy(card->longname, "Gravis UltraSound Ace");
 361                                 gus->ace_flag = 1;
 362                         } else if (rev == 0x50) {
 363                                 strcpy(card->driver, "GUS Extreme");
 364                                 strcpy(card->longname, "Gravis UltraSound Extreme");
 365                                 gus->ess_flag = 1;
 366                         } else {
 367                                 snd_printk(KERN_ERR "unknown GF1 revision number at 0x%lx - 0x%x (0x%x)\n", gus->gf1.port, rev, val);
 368                                 snd_printk(KERN_ERR "  please - report to <perex@perex.cz>\n");
 369                         }
 370                 }
 371         }
 372         strscpy(card->shortname, card->longname, sizeof(card->shortname));
 373         gus->uart_enable = 1;   /* standard GUSes doesn't have midi uart trouble */
 374         snd_gus_init_control(gus);
 375         return 0;
 376 }
 377
 378 int snd_gus_initialize(struct snd_gus_card *gus)
 379 {
 380         int err;
 381
 382         if (!gus->interwave) {
 383                 err = snd_gus_check_version(gus);
 384                 if (err < 0) {
 385                         snd_printk(KERN_ERR "version check failed\n");
 386                         return err;
 387                 }
 388                 err = snd_gus_detect_memory(gus);
 389                 if (err < 0)
 390                         return err;
 391         }
 392         err = snd_gus_init_dma_irq(gus, 1);
 393         if (err < 0)
 394                 return err;
 395         snd_gf1_start(gus);
 396         gus->initialized = 1;
 397         return 0;
 398 }
 399
 400   /* gus_io.c */
 401 EXPORT_SYMBOL(snd_gf1_delay);
 402 EXPORT_SYMBOL(snd_gf1_write8);
 403 EXPORT_SYMBOL(snd_gf1_look8);
 404 EXPORT_SYMBOL(snd_gf1_write16);
 405 EXPORT_SYMBOL(snd_gf1_look16);
 406 EXPORT_SYMBOL(snd_gf1_i_write8);
 407 EXPORT_SYMBOL(snd_gf1_i_look8);
 408 EXPORT_SYMBOL(snd_gf1_i_look16);
 409 EXPORT_SYMBOL(snd_gf1_dram_addr);
 410 EXPORT_SYMBOL(snd_gf1_write_addr);
 411 EXPORT_SYMBOL(snd_gf1_poke);
 412 EXPORT_SYMBOL(snd_gf1_peek);
 413   /* gus_reset.c */
 414 EXPORT_SYMBOL(snd_gf1_alloc_voice);
 415 EXPORT_SYMBOL(snd_gf1_free_voice);
 416 EXPORT_SYMBOL(snd_gf1_ctrl_stop);
 417 EXPORT_SYMBOL(snd_gf1_stop_voice);
 418   /* gus_mixer.c */
 419 EXPORT_SYMBOL(snd_gf1_new_mixer);
 420   /* gus_pcm.c */
 421 EXPORT_SYMBOL(snd_gf1_pcm_new);
 422   /* gus.c */
 423 EXPORT_SYMBOL(snd_gus_use_inc);
 424 EXPORT_SYMBOL(snd_gus_use_dec);
 425 EXPORT_SYMBOL(snd_gus_create);
 426 EXPORT_SYMBOL(snd_gus_initialize);
 427   /* gus_irq.c */
 428 EXPORT_SYMBOL(snd_gus_interrupt);
 429   /* gus_uart.c */
 430 EXPORT_SYMBOL(snd_gf1_rawmidi_new);
 431   /* gus_dram.c */
 432 EXPORT_SYMBOL(snd_gus_dram_write);
 433 EXPORT_SYMBOL(snd_gus_dram_read);
 434   /* gus_volume.c */
 435 EXPORT_SYMBOL(snd_gf1_lvol_to_gvol_raw);
 436 EXPORT_SYMBOL(snd_gf1_translate_freq);
 437   /* gus_mem.c */
 438 EXPORT_SYMBOL(snd_gf1_mem_alloc);
 439 EXPORT_SYMBOL(snd_gf1_mem_xfree);
 440 EXPORT_SYMBOL(snd_gf1_mem_free);
 441 EXPORT_SYMBOL(snd_gf1_mem_lock);