1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Routines for Gravis UltraSound soundcards
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
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>
19 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
20 MODULE_DESCRIPTION("Routines for Gravis UltraSound soundcards");
21 MODULE_LICENSE("GPL");
23 static int snd_gus_init_dma_irq(struct snd_gus_card * gus, int latches);
25 int snd_gus_use_inc(struct snd_gus_card * gus)
27 if (!try_module_get(gus->card->module))
32 void snd_gus_use_dec(struct snd_gus_card * gus)
34 module_put(gus->card->module);
37 static int snd_gus_joystick_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
39 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
41 uinfo->value.integer.min = 0;
42 uinfo->value.integer.max = 31;
46 static int snd_gus_joystick_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
48 struct snd_gus_card *gus = snd_kcontrol_chip(kcontrol);
50 ucontrol->value.integer.value[0] = gus->joystick_dac & 31;
54 static int snd_gus_joystick_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
56 struct snd_gus_card *gus = snd_kcontrol_chip(kcontrol);
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);
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
78 static void snd_gus_init_control(struct snd_gus_card *gus)
81 snd_ctl_add(gus->card, snd_ctl_new1(&snd_gus_joystick_control, gus));
88 static int snd_gus_free(struct snd_gus_card *gus)
90 if (gus->gf1.res_port2) {
92 snd_gus_init_dma_irq(gus, 0);
97 static int snd_gus_dev_free(struct snd_device *device)
99 struct snd_gus_card *gus = device->device_data;
100 return snd_gus_free(gus);
103 int snd_gus_create(struct snd_card *card,
105 int irq, int dma1, int dma2,
110 struct snd_gus_card **rgus)
112 struct snd_gus_card *gus;
114 static const struct snd_device_ops ops = {
115 .dev_free = snd_gus_dev_free,
119 gus = devm_kzalloc(card->dev, sizeof(*gus), GFP_KERNEL);
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);
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);
151 gus->gf1.res_port2 = devm_request_region(card->dev, port + 0x100, 12,
153 if (!gus->gf1.res_port2) {
154 snd_printk(KERN_ERR "gus: can't grab synth port 0x%lx\n", port + 0x100);
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);
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);
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);
174 gus->gf1.dma2 = dma2;
176 gus->gf1.dma2 = gus->gf1.dma1;
179 gus->timer_dev = timer_dev;
184 if (pcm_channels < 0)
186 if (pcm_channels > 8)
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);
203 * Memory detection routine for plain GF1 soundcards
206 static int snd_gus_detect_memory(struct snd_gus_card * gus)
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);
217 for (idx = 1, d = 0xab; idx < 4; idx++, d++) {
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)
227 gus->gf1.memory = idx << 18;
229 gus->gf1.memory = 256 * 1024;
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;
237 gus->gf1.mem_alloc.banks_8[0].size = gus->gf1.memory;
238 return 0; /* some memory were detected */
241 static int snd_gus_init_dma_irq(struct snd_gus_card * gus, int latches)
243 struct snd_card *card;
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};
251 if (snd_BUG_ON(!gus))
254 if (snd_BUG_ON(!card))
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 */
263 dma1 = gus->gf1.dma1;
265 dma1 = dmas[dma1 & 7];
266 dma2 = gus->gf1.dma2;
268 dma2 = dmas[dma2 & 7];
269 dma1 |= gus->equal_dma ? 0x40 : (dma2 << 3);
271 if ((dma1 & 7) == 0 || (dma2 & 7) == 0) {
272 snd_printk(KERN_ERR "Error! DMA isn't defined.\n");
277 irq = irqs[irq & 0x0f];
279 snd_printk(KERN_ERR "Error! IRQ isn't defined.\n");
284 card->mixer.mix_ctrl_reg |= 0x10;
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);
296 spin_lock_irqsave(&gus->reg_lock, flags);
297 outb(0x00 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
298 outb(dma1, GUSP(gus, IRQDMACNTRLREG));
300 outb(0x40 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
301 outb(irq, GUSP(gus, IRQDMACNTRLREG));
303 spin_unlock_irqrestore(&gus->reg_lock, flags);
307 spin_lock_irqsave(&gus->reg_lock, flags);
308 outb(0x00 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
309 outb(dma1, GUSP(gus, IRQDMACNTRLREG));
311 outb(0x40 | gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
312 outb(irq, GUSP(gus, IRQDMACNTRLREG));
314 spin_unlock_irqrestore(&gus->reg_lock, flags);
319 gus->mix_cntrl_reg |= 0x08; /* enable latches */
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);
330 static int snd_gus_check_version(struct snd_gus_card * gus)
333 unsigned char val, rev;
334 struct snd_card *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) {
349 gus->ics_flipped = 1;
350 card->longname[27] = '3';
351 card->longname[29] = rev == 5 ? '5' : '7';
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");
358 } else if (rev == 0x30) {
359 strcpy(card->driver, "GUS ACE");
360 strcpy(card->longname, "Gravis UltraSound Ace");
362 } else if (rev == 0x50) {
363 strcpy(card->driver, "GUS Extreme");
364 strcpy(card->longname, "Gravis UltraSound Extreme");
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");
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);
378 int snd_gus_initialize(struct snd_gus_card *gus)
382 if (!gus->interwave) {
383 err = snd_gus_check_version(gus);
385 snd_printk(KERN_ERR "version check failed\n");
388 err = snd_gus_detect_memory(gus);
392 err = snd_gus_init_dma_irq(gus, 1);
396 gus->initialized = 1;
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);
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);
419 EXPORT_SYMBOL(snd_gf1_new_mixer);
421 EXPORT_SYMBOL(snd_gf1_pcm_new);
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);
428 EXPORT_SYMBOL(snd_gus_interrupt);
430 EXPORT_SYMBOL(snd_gf1_rawmidi_new);
432 EXPORT_SYMBOL(snd_gus_dram_write);
433 EXPORT_SYMBOL(snd_gus_dram_read);
435 EXPORT_SYMBOL(snd_gf1_lvol_to_gvol_raw);
436 EXPORT_SYMBOL(snd_gf1_translate_freq);
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);