blob: dd88c9d33492bba72365f9785319ee665e5d92cc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Driver for Gravis UltraSound MAX soundcard
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02003 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/init.h>
Takashi Iwai654aa662005-11-17 17:13:43 +010023#include <linux/err.h>
Takashi Iwai5e24c1c2007-02-22 12:50:54 +010024#include <linux/isa.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/delay.h>
26#include <linux/time.h>
Paul Gortmaker65a77212011-07-15 13:13:37 -040027#include <linux/module.h>
Takashi Iwai654aa662005-11-17 17:13:43 +010028#include <asm/dma.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <sound/core.h>
30#include <sound/gus.h>
Krzysztof Helt61ef19d2008-07-31 21:02:42 +020031#include <sound/wss.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#define SNDRV_LEGACY_FIND_FREE_IRQ
33#define SNDRV_LEGACY_FIND_FREE_DMA
34#include <sound/initval.h>
35
Jaroslav Kyselac1017a42007-10-15 09:50:19 +020036MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
Linus Torvalds1da177e2005-04-16 15:20:36 -070037MODULE_DESCRIPTION("Gravis UltraSound MAX");
38MODULE_LICENSE("GPL");
39MODULE_SUPPORTED_DEVICE("{{Gravis,UltraSound MAX}}");
40
41static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
42static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
Rusty Russella67ff6a2011-12-15 13:49:36 +103043static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220,0x230,0x240,0x250,0x260 */
45static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 2,3,5,9,11,12,15 */
46static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 1,3,5,6,7 */
47static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 1,3,5,6,7 */
48static int joystick_dac[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 29};
49 /* 0 to 31, (0.59V-4.52V or 0.389V-2.98V) */
50static int channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 24};
51static int pcm_channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 2};
52
53module_param_array(index, int, NULL, 0444);
54MODULE_PARM_DESC(index, "Index value for GUS MAX soundcard.");
55module_param_array(id, charp, NULL, 0444);
56MODULE_PARM_DESC(id, "ID string for GUS MAX soundcard.");
57module_param_array(enable, bool, NULL, 0444);
58MODULE_PARM_DESC(enable, "Enable GUS MAX soundcard.");
59module_param_array(port, long, NULL, 0444);
60MODULE_PARM_DESC(port, "Port # for GUS MAX driver.");
61module_param_array(irq, int, NULL, 0444);
62MODULE_PARM_DESC(irq, "IRQ # for GUS MAX driver.");
63module_param_array(dma1, int, NULL, 0444);
64MODULE_PARM_DESC(dma1, "DMA1 # for GUS MAX driver.");
65module_param_array(dma2, int, NULL, 0444);
66MODULE_PARM_DESC(dma2, "DMA2 # for GUS MAX driver.");
67module_param_array(joystick_dac, int, NULL, 0444);
68MODULE_PARM_DESC(joystick_dac, "Joystick DAC level 0.59V-4.52V or 0.389V-2.98V for GUS MAX driver.");
69module_param_array(channels, int, NULL, 0444);
70MODULE_PARM_DESC(channels, "Used GF1 channels for GUS MAX driver.");
71module_param_array(pcm_channels, int, NULL, 0444);
72MODULE_PARM_DESC(pcm_channels, "Reserved PCM channels for GUS MAX driver.");
73
74struct snd_gusmax {
75 int irq;
Takashi Iwai5e2da202005-11-17 14:36:44 +010076 struct snd_card *card;
77 struct snd_gus_card *gus;
Krzysztof Helt7779f752008-07-31 21:03:41 +020078 struct snd_wss *wss;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 unsigned short gus_status_reg;
80 unsigned short pcm_status_reg;
81};
82
Takashi Iwai43bcd972005-09-05 17:19:20 +020083#define PFX "gusmax: "
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Bill Pemberton1bff2922012-12-06 12:35:21 -050085static int snd_gusmax_detect(struct snd_gus_card *gus)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086{
Takashi Iwai43bcd972005-09-05 17:19:20 +020087 unsigned char d;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Takashi Iwai43bcd972005-09-05 17:19:20 +020089 snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0); /* reset GF1 */
90 if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 0) {
91 snd_printdd("[0x%lx] check 1 failed - 0x%x\n", gus->gf1.port, d);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 return -ENODEV;
Takashi Iwai43bcd972005-09-05 17:19:20 +020093 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 udelay(160);
95 snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1); /* release reset */
96 udelay(160);
Takashi Iwai43bcd972005-09-05 17:19:20 +020097 if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 1) {
98 snd_printdd("[0x%lx] check 2 failed - 0x%x\n", gus->gf1.port, d);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 return -ENODEV;
Takashi Iwai43bcd972005-09-05 17:19:20 +0200100 }
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 return 0;
103}
104
David Howells7d12e782006-10-05 14:55:46 +0100105static irqreturn_t snd_gusmax_interrupt(int irq, void *dev_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
Jeff Garzikc7bec5a2006-10-06 15:00:58 -0400107 struct snd_gusmax *maxcard = dev_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 int loop, max = 5;
109 int handled = 0;
110
111 do {
112 loop = 0;
113 if (inb(maxcard->gus_status_reg)) {
114 handled = 1;
David Howells7d12e782006-10-05 14:55:46 +0100115 snd_gus_interrupt(irq, maxcard->gus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 loop++;
117 }
118 if (inb(maxcard->pcm_status_reg) & 0x01) { /* IRQ bit is set? */
119 handled = 1;
Krzysztof Helt7779f752008-07-31 21:03:41 +0200120 snd_wss_interrupt(irq, maxcard->wss);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 loop++;
122 }
123 } while (loop && --max > 0);
124 return IRQ_RETVAL(handled);
125}
126
Bill Pemberton1bff2922012-12-06 12:35:21 -0500127static void snd_gusmax_init(int dev, struct snd_card *card,
128 struct snd_gus_card *gus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
130 gus->equal_irq = 1;
131 gus->codec_flag = 1;
132 gus->joystick_dac = joystick_dac[dev];
133 /* init control register */
134 gus->max_cntrl_val = (gus->gf1.port >> 4) & 0x0f;
135 if (gus->gf1.dma1 > 3)
136 gus->max_cntrl_val |= 0x10;
137 if (gus->gf1.dma2 > 3)
138 gus->max_cntrl_val |= 0x20;
139 gus->max_cntrl_val |= 0x40;
140 outb(gus->max_cntrl_val, GUSP(gus, MAXCNTRLPORT));
141}
142
Bill Pemberton1bff2922012-12-06 12:35:21 -0500143static int snd_gusmax_mixer(struct snd_wss *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
Takashi Iwai5e2da202005-11-17 14:36:44 +0100145 struct snd_card *card = chip->card;
146 struct snd_ctl_elem_id id1, id2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 int err;
148
149 memset(&id1, 0, sizeof(id1));
150 memset(&id2, 0, sizeof(id2));
151 id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
152 /* reassign AUXA to SYNTHESIZER */
153 strcpy(id1.name, "Aux Playback Switch");
154 strcpy(id2.name, "Synth Playback Switch");
155 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
156 return err;
157 strcpy(id1.name, "Aux Playback Volume");
158 strcpy(id2.name, "Synth Playback Volume");
159 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
160 return err;
161 /* reassign AUXB to CD */
162 strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
163 strcpy(id2.name, "CD Playback Switch");
164 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
165 return err;
166 strcpy(id1.name, "Aux Playback Volume");
167 strcpy(id2.name, "CD Playback Volume");
168 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
169 return err;
170#if 0
171 /* reassign Mono Input to MIC */
172 if (snd_mixer_group_rename(mixer,
173 SNDRV_MIXER_IN_MONO, 0,
174 SNDRV_MIXER_IN_MIC, 0) < 0)
175 goto __error;
176 if (snd_mixer_elem_rename(mixer,
177 SNDRV_MIXER_IN_MONO, 0, SNDRV_MIXER_ETYPE_INPUT,
178 SNDRV_MIXER_IN_MIC, 0) < 0)
179 goto __error;
180 if (snd_mixer_elem_rename(mixer,
181 "Mono Capture Volume", 0, SNDRV_MIXER_ETYPE_VOLUME1,
182 "Mic Capture Volume", 0) < 0)
183 goto __error;
184 if (snd_mixer_elem_rename(mixer,
185 "Mono Capture Switch", 0, SNDRV_MIXER_ETYPE_SWITCH1,
186 "Mic Capture Switch", 0) < 0)
187 goto __error;
188#endif
189 return 0;
190}
191
Takashi Iwai5e2da202005-11-17 14:36:44 +0100192static void snd_gusmax_free(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
Joe Perches9fe856e2010-09-04 18:52:54 -0700194 struct snd_gusmax *maxcard = card->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196 if (maxcard == NULL)
197 return;
198 if (maxcard->irq >= 0)
199 free_irq(maxcard->irq, (void *)maxcard);
200}
201
Bill Pemberton1bff2922012-12-06 12:35:21 -0500202static int snd_gusmax_match(struct device *pdev, unsigned int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
Takashi Iwai5e24c1c2007-02-22 12:50:54 +0100204 return enable[dev];
205}
206
Bill Pemberton1bff2922012-12-06 12:35:21 -0500207static int snd_gusmax_probe(struct device *pdev, unsigned int dev)
Takashi Iwai5e24c1c2007-02-22 12:50:54 +0100208{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 static int possible_irqs[] = {5, 11, 12, 9, 7, 15, 3, -1};
210 static int possible_dmas[] = {5, 6, 7, 1, 3, -1};
211 int xirq, xdma1, xdma2, err;
Takashi Iwai5e2da202005-11-17 14:36:44 +0100212 struct snd_card *card;
213 struct snd_gus_card *gus = NULL;
Krzysztof Helt7779f752008-07-31 21:03:41 +0200214 struct snd_wss *wss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 struct snd_gusmax *maxcard;
216
Takashi Iwai4323cc42014-01-29 13:03:56 +0100217 err = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
218 sizeof(struct snd_gusmax), &card);
Takashi Iwaic95eadd2008-12-28 16:43:35 +0100219 if (err < 0)
220 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 card->private_free = snd_gusmax_free;
Joe Perches9fe856e2010-09-04 18:52:54 -0700222 maxcard = card->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 maxcard->card = card;
224 maxcard->irq = -1;
225
226 xirq = irq[dev];
227 if (xirq == SNDRV_AUTO_IRQ) {
228 if ((xirq = snd_legacy_find_free_irq(possible_irqs)) < 0) {
Takashi Iwai43bcd972005-09-05 17:19:20 +0200229 snd_printk(KERN_ERR PFX "unable to find a free IRQ\n");
230 err = -EBUSY;
231 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 }
233 }
234 xdma1 = dma1[dev];
235 if (xdma1 == SNDRV_AUTO_DMA) {
236 if ((xdma1 = snd_legacy_find_free_dma(possible_dmas)) < 0) {
Takashi Iwai43bcd972005-09-05 17:19:20 +0200237 snd_printk(KERN_ERR PFX "unable to find a free DMA1\n");
238 err = -EBUSY;
239 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 }
241 }
242 xdma2 = dma2[dev];
243 if (xdma2 == SNDRV_AUTO_DMA) {
244 if ((xdma2 = snd_legacy_find_free_dma(possible_dmas)) < 0) {
Takashi Iwai43bcd972005-09-05 17:19:20 +0200245 snd_printk(KERN_ERR PFX "unable to find a free DMA2\n");
246 err = -EBUSY;
247 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 }
249 }
250
Takashi Iwai654aa662005-11-17 17:13:43 +0100251 if (port[dev] != SNDRV_AUTO_PORT) {
252 err = snd_gus_create(card,
253 port[dev],
254 -xirq, xdma1, xdma2,
255 0, channels[dev],
256 pcm_channels[dev],
257 0, &gus);
258 } else {
259 static unsigned long possible_ports[] = {
260 0x220, 0x230, 0x240, 0x250, 0x260
261 };
262 int i;
263 for (i = 0; i < ARRAY_SIZE(possible_ports); i++) {
264 err = snd_gus_create(card,
265 possible_ports[i],
266 -xirq, xdma1, xdma2,
267 0, channels[dev],
268 pcm_channels[dev],
269 0, &gus);
270 if (err >= 0) {
271 port[dev] = possible_ports[i];
272 break;
273 }
274 }
275 }
276 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200277 goto _err;
278
279 if ((err = snd_gusmax_detect(gus)) < 0)
280 goto _err;
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 maxcard->gus_status_reg = gus->gf1.reg_irqstat;
283 maxcard->pcm_status_reg = gus->gf1.port + 0x10c + 2;
284 snd_gusmax_init(dev, card, gus);
Takashi Iwai43bcd972005-09-05 17:19:20 +0200285 if ((err = snd_gus_initialize(gus)) < 0)
286 goto _err;
287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 if (!gus->max_flag) {
Takashi Iwai43bcd972005-09-05 17:19:20 +0200289 snd_printk(KERN_ERR PFX "GUS MAX soundcard was not detected at 0x%lx\n", gus->gf1.port);
290 err = -ENODEV;
291 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 }
293
Yong Zhang88e24c32011-09-22 16:59:20 +0800294 if (request_irq(xirq, snd_gusmax_interrupt, 0, "GUS MAX", (void *)maxcard)) {
Takashi Iwai43bcd972005-09-05 17:19:20 +0200295 snd_printk(KERN_ERR PFX "unable to grab IRQ %d\n", xirq);
296 err = -EBUSY;
297 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 }
299 maxcard->irq = xirq;
300
Krzysztof Helt7779f752008-07-31 21:03:41 +0200301 err = snd_wss_create(card,
302 gus->gf1.port + 0x10c, -1, xirq,
303 xdma2 < 0 ? xdma1 : xdma2, xdma1,
304 WSS_HW_DETECT,
305 WSS_HWSHARE_IRQ |
306 WSS_HWSHARE_DMA1 |
307 WSS_HWSHARE_DMA2,
308 &wss);
309 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200310 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Lars-Peter Clausenfa60c062015-01-02 12:24:43 +0100312 err = snd_wss_pcm(wss, 0);
Krzysztof Helt7779f752008-07-31 21:03:41 +0200313 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200314 goto _err;
315
Krzysztof Helt7779f752008-07-31 21:03:41 +0200316 err = snd_wss_mixer(wss);
317 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200318 goto _err;
319
Lars-Peter Clausenfa60c062015-01-02 12:24:43 +0100320 err = snd_wss_timer(wss, 2);
Krzysztof Helt7779f752008-07-31 21:03:41 +0200321 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200322 goto _err;
323
324 if (pcm_channels[dev] > 0) {
Lars-Peter Clausendb5abb32015-01-02 12:24:39 +0100325 if ((err = snd_gf1_pcm_new(gus, 1, 1)) < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200326 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 }
Krzysztof Helt7779f752008-07-31 21:03:41 +0200328 err = snd_gusmax_mixer(wss);
329 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200330 goto _err;
331
Lars-Peter Clausendb5abb32015-01-02 12:24:39 +0100332 err = snd_gf1_rawmidi_new(gus, 0);
Krzysztof Helt7779f752008-07-31 21:03:41 +0200333 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200334 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336 sprintf(card->longname + strlen(card->longname), " at 0x%lx, irq %i, dma %i", gus->gf1.port, xirq, xdma1);
337 if (xdma2 >= 0)
338 sprintf(card->longname + strlen(card->longname), "&%i", xdma2);
Takashi Iwai43bcd972005-09-05 17:19:20 +0200339
Krzysztof Helt7779f752008-07-31 21:03:41 +0200340 err = snd_card_register(card);
341 if (err < 0)
Takashi Iwai43bcd972005-09-05 17:19:20 +0200342 goto _err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344 maxcard->gus = gus;
Krzysztof Helt7779f752008-07-31 21:03:41 +0200345 maxcard->wss = wss;
Takashi Iwai654aa662005-11-17 17:13:43 +0100346
Takashi Iwai5e24c1c2007-02-22 12:50:54 +0100347 dev_set_drvdata(pdev, card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 return 0;
Takashi Iwai43bcd972005-09-05 17:19:20 +0200349
350 _err:
351 snd_card_free(card);
352 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353}
354
Bill Pemberton1bff2922012-12-06 12:35:21 -0500355static int snd_gusmax_remove(struct device *devptr, unsigned int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356{
Takashi Iwai5e24c1c2007-02-22 12:50:54 +0100357 snd_card_free(dev_get_drvdata(devptr));
Takashi Iwai654aa662005-11-17 17:13:43 +0100358 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359}
360
Rene Herman83c51c02007-03-20 11:33:46 +0100361#define DEV_NAME "gusmax"
Takashi Iwai654aa662005-11-17 17:13:43 +0100362
Takashi Iwai5e24c1c2007-02-22 12:50:54 +0100363static struct isa_driver snd_gusmax_driver = {
364 .match = snd_gusmax_match,
Takashi Iwai654aa662005-11-17 17:13:43 +0100365 .probe = snd_gusmax_probe,
Bill Pemberton1bff2922012-12-06 12:35:21 -0500366 .remove = snd_gusmax_remove,
Takashi Iwai654aa662005-11-17 17:13:43 +0100367 /* FIXME: suspend/resume */
368 .driver = {
Rene Herman83c51c02007-03-20 11:33:46 +0100369 .name = DEV_NAME
Takashi Iwai654aa662005-11-17 17:13:43 +0100370 },
371};
372
William Breathitt Graya99e8c62016-05-31 11:55:48 -0400373module_isa_driver(snd_gusmax_driver, SNDRV_CARDS);