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