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