GNU Linux-libre 4.19.286-gnu1
[releases.git] / sound / isa / msnd / msnd_pinnacle.c
1 /*********************************************************************
2  *
3  * Linux multisound pinnacle/fiji driver for ALSA.
4  *
5  * 2002/06/30 Karsten Wiese:
6  *      for now this is only used to build a pinnacle / fiji driver.
7  *      the OSS parent of this code is designed to also support
8  *      the multisound classic via the file msnd_classic.c.
9  *      to make it easier for some brave heart to implemt classic
10  *      support in alsa, i left all the MSND_CLASSIC tokens in this file.
11  *      but for now this untested & undone.
12  *
13  *
14  * ripped from linux kernel 2.4.18 by Karsten Wiese.
15  *
16  * the following is a copy of the 2.4.18 OSS FREE file-heading comment:
17  *
18  * Turtle Beach MultiSound Sound Card Driver for Linux
19  * msnd_pinnacle.c / msnd_classic.c
20  *
21  * -- If MSND_CLASSIC is defined:
22  *
23  *     -> driver for Turtle Beach Classic/Monterey/Tahiti
24  *
25  * -- Else
26  *
27  *     -> driver for Turtle Beach Pinnacle/Fiji
28  *
29  * 12-3-2000  Modified IO port validation  Steve Sycamore
30  *
31  * Copyright (C) 1998 Andrew Veliath
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License
44  * along with this program; if not, write to the Free Software
45  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
46  *
47  ********************************************************************/
48
49 #include <linux/kernel.h>
50 #include <linux/module.h>
51 #include <linux/interrupt.h>
52 #include <linux/types.h>
53 #include <linux/delay.h>
54 #include <linux/ioport.h>
55 #include <linux/firmware.h>
56 #include <linux/isa.h>
57 #include <linux/isapnp.h>
58 #include <linux/irq.h>
59 #include <linux/io.h>
60
61 #include <sound/core.h>
62 #include <sound/initval.h>
63 #include <sound/asound.h>
64 #include <sound/pcm.h>
65 #include <sound/mpu401.h>
66
67 #ifdef MSND_CLASSIC
68 # ifndef __alpha__
69 #  define SLOWIO
70 # endif
71 #endif
72 #include "msnd.h"
73 #ifdef MSND_CLASSIC
74 #  include "msnd_classic.h"
75 #  define LOGNAME                       "msnd_classic"
76 #  define DEV_NAME                      "msnd-classic"
77 #else
78 #  include "msnd_pinnacle.h"
79 #  define LOGNAME                       "snd_msnd_pinnacle"
80 #  define DEV_NAME                      "msnd-pinnacle"
81 #endif
82
83 static void set_default_audio_parameters(struct snd_msnd *chip)
84 {
85         chip->play_sample_size = snd_pcm_format_width(DEFSAMPLESIZE);
86         chip->play_sample_rate = DEFSAMPLERATE;
87         chip->play_channels = DEFCHANNELS;
88         chip->capture_sample_size = snd_pcm_format_width(DEFSAMPLESIZE);
89         chip->capture_sample_rate = DEFSAMPLERATE;
90         chip->capture_channels = DEFCHANNELS;
91 }
92
93 static void snd_msnd_eval_dsp_msg(struct snd_msnd *chip, u16 wMessage)
94 {
95         switch (HIBYTE(wMessage)) {
96         case HIMT_PLAY_DONE: {
97                 if (chip->banksPlayed < 3)
98                         snd_printdd("%08X: HIMT_PLAY_DONE: %i\n",
99                                 (unsigned)jiffies, LOBYTE(wMessage));
100
101                 if (chip->last_playbank == LOBYTE(wMessage)) {
102                         snd_printdd("chip.last_playbank == LOBYTE(wMessage)\n");
103                         break;
104                 }
105                 chip->banksPlayed++;
106
107                 if (test_bit(F_WRITING, &chip->flags))
108                         snd_msnd_DAPQ(chip, 0);
109
110                 chip->last_playbank = LOBYTE(wMessage);
111                 chip->playDMAPos += chip->play_period_bytes;
112                 if (chip->playDMAPos > chip->playLimit)
113                         chip->playDMAPos = 0;
114                 snd_pcm_period_elapsed(chip->playback_substream);
115
116                 break;
117         }
118         case HIMT_RECORD_DONE:
119                 if (chip->last_recbank == LOBYTE(wMessage))
120                         break;
121                 chip->last_recbank = LOBYTE(wMessage);
122                 chip->captureDMAPos += chip->capturePeriodBytes;
123                 if (chip->captureDMAPos > (chip->captureLimit))
124                         chip->captureDMAPos = 0;
125
126                 if (test_bit(F_READING, &chip->flags))
127                         snd_msnd_DARQ(chip, chip->last_recbank);
128
129                 snd_pcm_period_elapsed(chip->capture_substream);
130                 break;
131
132         case HIMT_DSP:
133                 switch (LOBYTE(wMessage)) {
134 #ifndef MSND_CLASSIC
135                 case HIDSP_PLAY_UNDER:
136 #endif
137                 case HIDSP_INT_PLAY_UNDER:
138                         snd_printd(KERN_WARNING LOGNAME ": Play underflow %i\n",
139                                 chip->banksPlayed);
140                         if (chip->banksPlayed > 2)
141                                 clear_bit(F_WRITING, &chip->flags);
142                         break;
143
144                 case HIDSP_INT_RECORD_OVER:
145                         snd_printd(KERN_WARNING LOGNAME ": Record overflow\n");
146                         clear_bit(F_READING, &chip->flags);
147                         break;
148
149                 default:
150                         snd_printd(KERN_WARNING LOGNAME
151                                    ": DSP message %d 0x%02x\n",
152                                    LOBYTE(wMessage), LOBYTE(wMessage));
153                         break;
154                 }
155                 break;
156
157         case HIMT_MIDI_IN_UCHAR:
158                 if (chip->msndmidi_mpu)
159                         snd_msndmidi_input_read(chip->msndmidi_mpu);
160                 break;
161
162         default:
163                 snd_printd(KERN_WARNING LOGNAME ": HIMT message %d 0x%02x\n",
164                            HIBYTE(wMessage), HIBYTE(wMessage));
165                 break;
166         }
167 }
168
169 static irqreturn_t snd_msnd_interrupt(int irq, void *dev_id)
170 {
171         struct snd_msnd *chip = dev_id;
172         void __iomem *pwDSPQData = chip->mappedbase + DSPQ_DATA_BUFF;
173         u16 head, tail, size;
174
175         /* Send ack to DSP */
176         /* inb(chip->io + HP_RXL); */
177
178         /* Evaluate queued DSP messages */
179         head = readw(chip->DSPQ + JQS_wHead);
180         tail = readw(chip->DSPQ + JQS_wTail);
181         size = readw(chip->DSPQ + JQS_wSize);
182         if (head > size || tail > size)
183                 goto out;
184         while (head != tail) {
185                 snd_msnd_eval_dsp_msg(chip, readw(pwDSPQData + 2 * head));
186                 if (++head > size)
187                         head = 0;
188                 writew(head, chip->DSPQ + JQS_wHead);
189         }
190  out:
191         /* Send ack to DSP */
192         inb(chip->io + HP_RXL);
193         return IRQ_HANDLED;
194 }
195
196
197 static int snd_msnd_reset_dsp(long io, unsigned char *info)
198 {
199         int timeout = 100;
200
201         outb(HPDSPRESET_ON, io + HP_DSPR);
202         msleep(1);
203 #ifndef MSND_CLASSIC
204         if (info)
205                 *info = inb(io + HP_INFO);
206 #endif
207         outb(HPDSPRESET_OFF, io + HP_DSPR);
208         msleep(1);
209         while (timeout-- > 0) {
210                 if (inb(io + HP_CVR) == HP_CVR_DEF)
211                         return 0;
212                 msleep(1);
213         }
214         snd_printk(KERN_ERR LOGNAME ": Cannot reset DSP\n");
215
216         return -EIO;
217 }
218
219 static int snd_msnd_probe(struct snd_card *card)
220 {
221         struct snd_msnd *chip = card->private_data;
222         unsigned char info;
223 #ifndef MSND_CLASSIC
224         char *xv, *rev = NULL;
225         char *pin = "TB Pinnacle", *fiji = "TB Fiji";
226         char *pinfiji = "TB Pinnacle/Fiji";
227 #endif
228
229         if (!request_region(chip->io, DSP_NUMIO, "probing")) {
230                 snd_printk(KERN_ERR LOGNAME ": I/O port conflict\n");
231                 return -ENODEV;
232         }
233
234         if (snd_msnd_reset_dsp(chip->io, &info) < 0) {
235                 release_region(chip->io, DSP_NUMIO);
236                 return -ENODEV;
237         }
238
239 #ifdef MSND_CLASSIC
240         strcpy(card->shortname, "Classic/Tahiti/Monterey");
241         strcpy(card->longname, "Turtle Beach Multisound");
242         printk(KERN_INFO LOGNAME ": %s, "
243                "I/O 0x%lx-0x%lx, IRQ %d, memory mapped to 0x%lX-0x%lX\n",
244                card->shortname,
245                chip->io, chip->io + DSP_NUMIO - 1,
246                chip->irq,
247                chip->base, chip->base + 0x7fff);
248 #else
249         switch (info >> 4) {
250         case 0xf:
251                 xv = "<= 1.15";
252                 break;
253         case 0x1:
254                 xv = "1.18/1.2";
255                 break;
256         case 0x2:
257                 xv = "1.3";
258                 break;
259         case 0x3:
260                 xv = "1.4";
261                 break;
262         default:
263                 xv = "unknown";
264                 break;
265         }
266
267         switch (info & 0x7) {
268         case 0x0:
269                 rev = "I";
270                 strcpy(card->shortname, pin);
271                 break;
272         case 0x1:
273                 rev = "F";
274                 strcpy(card->shortname, pin);
275                 break;
276         case 0x2:
277                 rev = "G";
278                 strcpy(card->shortname, pin);
279                 break;
280         case 0x3:
281                 rev = "H";
282                 strcpy(card->shortname, pin);
283                 break;
284         case 0x4:
285                 rev = "E";
286                 strcpy(card->shortname, fiji);
287                 break;
288         case 0x5:
289                 rev = "C";
290                 strcpy(card->shortname, fiji);
291                 break;
292         case 0x6:
293                 rev = "D";
294                 strcpy(card->shortname, fiji);
295                 break;
296         case 0x7:
297                 rev = "A-B (Fiji) or A-E (Pinnacle)";
298                 strcpy(card->shortname, pinfiji);
299                 break;
300         }
301         strcpy(card->longname, "Turtle Beach Multisound Pinnacle");
302         printk(KERN_INFO LOGNAME ": %s revision %s, Xilinx version %s, "
303                "I/O 0x%lx-0x%lx, IRQ %d, memory mapped to 0x%lX-0x%lX\n",
304                card->shortname,
305                rev, xv,
306                chip->io, chip->io + DSP_NUMIO - 1,
307                chip->irq,
308                chip->base, chip->base + 0x7fff);
309 #endif
310
311         release_region(chip->io, DSP_NUMIO);
312         return 0;
313 }
314
315 static int snd_msnd_init_sma(struct snd_msnd *chip)
316 {
317         static int initted;
318         u16 mastVolLeft, mastVolRight;
319         unsigned long flags;
320
321 #ifdef MSND_CLASSIC
322         outb(chip->memid, chip->io + HP_MEMM);
323 #endif
324         outb(HPBLKSEL_0, chip->io + HP_BLKS);
325         /* Motorola 56k shared memory base */
326         chip->SMA = chip->mappedbase + SMA_STRUCT_START;
327
328         if (initted) {
329                 mastVolLeft = readw(chip->SMA + SMA_wCurrMastVolLeft);
330                 mastVolRight = readw(chip->SMA + SMA_wCurrMastVolRight);
331         } else
332                 mastVolLeft = mastVolRight = 0;
333         memset_io(chip->mappedbase, 0, 0x8000);
334
335         /* Critical section: bank 1 access */
336         spin_lock_irqsave(&chip->lock, flags);
337         outb(HPBLKSEL_1, chip->io + HP_BLKS);
338         memset_io(chip->mappedbase, 0, 0x8000);
339         outb(HPBLKSEL_0, chip->io + HP_BLKS);
340         spin_unlock_irqrestore(&chip->lock, flags);
341
342         /* Digital audio play queue */
343         chip->DAPQ = chip->mappedbase + DAPQ_OFFSET;
344         snd_msnd_init_queue(chip->DAPQ, DAPQ_DATA_BUFF, DAPQ_BUFF_SIZE);
345
346         /* Digital audio record queue */
347         chip->DARQ = chip->mappedbase + DARQ_OFFSET;
348         snd_msnd_init_queue(chip->DARQ, DARQ_DATA_BUFF, DARQ_BUFF_SIZE);
349
350         /* MIDI out queue */
351         chip->MODQ = chip->mappedbase + MODQ_OFFSET;
352         snd_msnd_init_queue(chip->MODQ, MODQ_DATA_BUFF, MODQ_BUFF_SIZE);
353
354         /* MIDI in queue */
355         chip->MIDQ = chip->mappedbase + MIDQ_OFFSET;
356         snd_msnd_init_queue(chip->MIDQ, MIDQ_DATA_BUFF, MIDQ_BUFF_SIZE);
357
358         /* DSP -> host message queue */
359         chip->DSPQ = chip->mappedbase + DSPQ_OFFSET;
360         snd_msnd_init_queue(chip->DSPQ, DSPQ_DATA_BUFF, DSPQ_BUFF_SIZE);
361
362         /* Setup some DSP values */
363 #ifndef MSND_CLASSIC
364         writew(1, chip->SMA + SMA_wCurrPlayFormat);
365         writew(chip->play_sample_size, chip->SMA + SMA_wCurrPlaySampleSize);
366         writew(chip->play_channels, chip->SMA + SMA_wCurrPlayChannels);
367         writew(chip->play_sample_rate, chip->SMA + SMA_wCurrPlaySampleRate);
368 #endif
369         writew(chip->play_sample_rate, chip->SMA + SMA_wCalFreqAtoD);
370         writew(mastVolLeft, chip->SMA + SMA_wCurrMastVolLeft);
371         writew(mastVolRight, chip->SMA + SMA_wCurrMastVolRight);
372 #ifndef MSND_CLASSIC
373         writel(0x00010000, chip->SMA + SMA_dwCurrPlayPitch);
374         writel(0x00000001, chip->SMA + SMA_dwCurrPlayRate);
375 #endif
376         writew(0x303, chip->SMA + SMA_wCurrInputTagBits);
377
378         initted = 1;
379
380         return 0;
381 }
382
383
384 static int upload_dsp_code(struct snd_card *card)
385 {
386         struct snd_msnd *chip = card->private_data;
387         const struct firmware *init_fw = NULL, *perm_fw = NULL;
388         int err;
389
390         outb(HPBLKSEL_0, chip->io + HP_BLKS);
391
392         err = reject_firmware(&init_fw, INITCODEFILE, card->dev);
393         if (err < 0) {
394                 printk(KERN_ERR LOGNAME ": Error loading " INITCODEFILE);
395                 goto cleanup1;
396         }
397         err = reject_firmware(&perm_fw, PERMCODEFILE, card->dev);
398         if (err < 0) {
399                 printk(KERN_ERR LOGNAME ": Error loading " PERMCODEFILE);
400                 goto cleanup;
401         }
402
403         memcpy_toio(chip->mappedbase, perm_fw->data, perm_fw->size);
404         if (snd_msnd_upload_host(chip, init_fw->data, init_fw->size) < 0) {
405                 printk(KERN_WARNING LOGNAME ": Error uploading to DSP\n");
406                 err = -ENODEV;
407                 goto cleanup;
408         }
409         printk(KERN_INFO LOGNAME ": DSP firmware uploaded\n");
410         err = 0;
411
412 cleanup:
413         release_firmware(perm_fw);
414 cleanup1:
415         release_firmware(init_fw);
416         return err;
417 }
418
419 #ifdef MSND_CLASSIC
420 static void reset_proteus(struct snd_msnd *chip)
421 {
422         outb(HPPRORESET_ON, chip->io + HP_PROR);
423         msleep(TIME_PRO_RESET);
424         outb(HPPRORESET_OFF, chip->io + HP_PROR);
425         msleep(TIME_PRO_RESET_DONE);
426 }
427 #endif
428
429 static int snd_msnd_initialize(struct snd_card *card)
430 {
431         struct snd_msnd *chip = card->private_data;
432         int err, timeout;
433
434 #ifdef MSND_CLASSIC
435         outb(HPWAITSTATE_0, chip->io + HP_WAIT);
436         outb(HPBITMODE_16, chip->io + HP_BITM);
437
438         reset_proteus(chip);
439 #endif
440         err = snd_msnd_init_sma(chip);
441         if (err < 0) {
442                 printk(KERN_WARNING LOGNAME ": Cannot initialize SMA\n");
443                 return err;
444         }
445
446         err = snd_msnd_reset_dsp(chip->io, NULL);
447         if (err < 0)
448                 return err;
449
450         err = upload_dsp_code(card);
451         if (err < 0) {
452                 printk(KERN_WARNING LOGNAME ": Cannot upload DSP code\n");
453                 return err;
454         }
455
456         timeout = 200;
457
458         while (readw(chip->mappedbase)) {
459                 msleep(1);
460                 if (!timeout--) {
461                         snd_printd(KERN_ERR LOGNAME ": DSP reset timeout\n");
462                         return -EIO;
463                 }
464         }
465
466         snd_msndmix_setup(chip);
467         return 0;
468 }
469
470 static int snd_msnd_dsp_full_reset(struct snd_card *card)
471 {
472         struct snd_msnd *chip = card->private_data;
473         int rv;
474
475         if (test_bit(F_RESETTING, &chip->flags) || ++chip->nresets > 10)
476                 return 0;
477
478         set_bit(F_RESETTING, &chip->flags);
479         snd_msnd_dsp_halt(chip, NULL);  /* Unconditionally halt */
480
481         rv = snd_msnd_initialize(card);
482         if (rv)
483                 printk(KERN_WARNING LOGNAME ": DSP reset failed\n");
484         snd_msndmix_force_recsrc(chip, 0);
485         clear_bit(F_RESETTING, &chip->flags);
486         return rv;
487 }
488
489 static int snd_msnd_dev_free(struct snd_device *device)
490 {
491         snd_printdd("snd_msnd_chip_free()\n");
492         return 0;
493 }
494
495 static int snd_msnd_send_dsp_cmd_chk(struct snd_msnd *chip, u8 cmd)
496 {
497         if (snd_msnd_send_dsp_cmd(chip, cmd) == 0)
498                 return 0;
499         snd_msnd_dsp_full_reset(chip->card);
500         return snd_msnd_send_dsp_cmd(chip, cmd);
501 }
502
503 static int snd_msnd_calibrate_adc(struct snd_msnd *chip, u16 srate)
504 {
505         snd_printdd("snd_msnd_calibrate_adc(%i)\n", srate);
506         writew(srate, chip->SMA + SMA_wCalFreqAtoD);
507         if (chip->calibrate_signal == 0)
508                 writew(readw(chip->SMA + SMA_wCurrHostStatusFlags)
509                        | 0x0001, chip->SMA + SMA_wCurrHostStatusFlags);
510         else
511                 writew(readw(chip->SMA + SMA_wCurrHostStatusFlags)
512                        & ~0x0001, chip->SMA + SMA_wCurrHostStatusFlags);
513         if (snd_msnd_send_word(chip, 0, 0, HDEXAR_CAL_A_TO_D) == 0 &&
514             snd_msnd_send_dsp_cmd_chk(chip, HDEX_AUX_REQ) == 0) {
515                 schedule_timeout_interruptible(msecs_to_jiffies(333));
516                 return 0;
517         }
518         printk(KERN_WARNING LOGNAME ": ADC calibration failed\n");
519         return -EIO;
520 }
521
522 /*
523  * ALSA callback function, called when attempting to open the MIDI device.
524  */
525 static int snd_msnd_mpu401_open(struct snd_mpu401 *mpu)
526 {
527         snd_msnd_enable_irq(mpu->private_data);
528         snd_msnd_send_dsp_cmd(mpu->private_data, HDEX_MIDI_IN_START);
529         return 0;
530 }
531
532 static void snd_msnd_mpu401_close(struct snd_mpu401 *mpu)
533 {
534         snd_msnd_send_dsp_cmd(mpu->private_data, HDEX_MIDI_IN_STOP);
535         snd_msnd_disable_irq(mpu->private_data);
536 }
537
538 static long mpu_io[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
539 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
540
541 static int snd_msnd_attach(struct snd_card *card)
542 {
543         struct snd_msnd *chip = card->private_data;
544         int err;
545         static struct snd_device_ops ops = {
546                 .dev_free =      snd_msnd_dev_free,
547                 };
548
549         err = request_irq(chip->irq, snd_msnd_interrupt, 0, card->shortname,
550                           chip);
551         if (err < 0) {
552                 printk(KERN_ERR LOGNAME ": Couldn't grab IRQ %d\n", chip->irq);
553                 return err;
554         }
555         if (request_region(chip->io, DSP_NUMIO, card->shortname) == NULL) {
556                 free_irq(chip->irq, chip);
557                 return -EBUSY;
558         }
559
560         if (!request_mem_region(chip->base, BUFFSIZE, card->shortname)) {
561                 printk(KERN_ERR LOGNAME
562                         ": unable to grab memory region 0x%lx-0x%lx\n",
563                         chip->base, chip->base + BUFFSIZE - 1);
564                 release_region(chip->io, DSP_NUMIO);
565                 free_irq(chip->irq, chip);
566                 return -EBUSY;
567         }
568         chip->mappedbase = ioremap_nocache(chip->base, 0x8000);
569         if (!chip->mappedbase) {
570                 printk(KERN_ERR LOGNAME
571                         ": unable to map memory region 0x%lx-0x%lx\n",
572                         chip->base, chip->base + BUFFSIZE - 1);
573                 err = -EIO;
574                 goto err_release_region;
575         }
576
577         err = snd_msnd_dsp_full_reset(card);
578         if (err < 0)
579                 goto err_release_region;
580
581         /* Register device */
582         err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
583         if (err < 0)
584                 goto err_release_region;
585
586         err = snd_msnd_pcm(card, 0);
587         if (err < 0) {
588                 printk(KERN_ERR LOGNAME ": error creating new PCM device\n");
589                 goto err_release_region;
590         }
591
592         err = snd_msndmix_new(card);
593         if (err < 0) {
594                 printk(KERN_ERR LOGNAME ": error creating new Mixer device\n");
595                 goto err_release_region;
596         }
597
598
599         if (mpu_io[0] != SNDRV_AUTO_PORT) {
600                 struct snd_mpu401 *mpu;
601
602                 err = snd_mpu401_uart_new(card, 0, MPU401_HW_MPU401,
603                                           mpu_io[0],
604                                           MPU401_MODE_INPUT |
605                                           MPU401_MODE_OUTPUT,
606                                           mpu_irq[0],
607                                           &chip->rmidi);
608                 if (err < 0) {
609                         printk(KERN_ERR LOGNAME
610                                 ": error creating new Midi device\n");
611                         goto err_release_region;
612                 }
613                 mpu = chip->rmidi->private_data;
614
615                 mpu->open_input = snd_msnd_mpu401_open;
616                 mpu->close_input = snd_msnd_mpu401_close;
617                 mpu->private_data = chip;
618         }
619
620         disable_irq(chip->irq);
621         snd_msnd_calibrate_adc(chip, chip->play_sample_rate);
622         snd_msndmix_force_recsrc(chip, 0);
623
624         err = snd_card_register(card);
625         if (err < 0)
626                 goto err_release_region;
627
628         return 0;
629
630 err_release_region:
631         iounmap(chip->mappedbase);
632         release_mem_region(chip->base, BUFFSIZE);
633         release_region(chip->io, DSP_NUMIO);
634         free_irq(chip->irq, chip);
635         return err;
636 }
637
638
639 static void snd_msnd_unload(struct snd_card *card)
640 {
641         struct snd_msnd *chip = card->private_data;
642
643         iounmap(chip->mappedbase);
644         release_mem_region(chip->base, BUFFSIZE);
645         release_region(chip->io, DSP_NUMIO);
646         free_irq(chip->irq, chip);
647         snd_card_free(card);
648 }
649
650 #ifndef MSND_CLASSIC
651
652 /* Pinnacle/Fiji Logical Device Configuration */
653
654 static int snd_msnd_write_cfg(int cfg, int reg, int value)
655 {
656         outb(reg, cfg);
657         outb(value, cfg + 1);
658         if (value != inb(cfg + 1)) {
659                 printk(KERN_ERR LOGNAME ": snd_msnd_write_cfg: I/O error\n");
660                 return -EIO;
661         }
662         return 0;
663 }
664
665 static int snd_msnd_write_cfg_io0(int cfg, int num, u16 io)
666 {
667         if (snd_msnd_write_cfg(cfg, IREG_LOGDEVICE, num))
668                 return -EIO;
669         if (snd_msnd_write_cfg(cfg, IREG_IO0_BASEHI, HIBYTE(io)))
670                 return -EIO;
671         if (snd_msnd_write_cfg(cfg, IREG_IO0_BASELO, LOBYTE(io)))
672                 return -EIO;
673         return 0;
674 }
675
676 static int snd_msnd_write_cfg_io1(int cfg, int num, u16 io)
677 {
678         if (snd_msnd_write_cfg(cfg, IREG_LOGDEVICE, num))
679                 return -EIO;
680         if (snd_msnd_write_cfg(cfg, IREG_IO1_BASEHI, HIBYTE(io)))
681                 return -EIO;
682         if (snd_msnd_write_cfg(cfg, IREG_IO1_BASELO, LOBYTE(io)))
683                 return -EIO;
684         return 0;
685 }
686
687 static int snd_msnd_write_cfg_irq(int cfg, int num, u16 irq)
688 {
689         if (snd_msnd_write_cfg(cfg, IREG_LOGDEVICE, num))
690                 return -EIO;
691         if (snd_msnd_write_cfg(cfg, IREG_IRQ_NUMBER, LOBYTE(irq)))
692                 return -EIO;
693         if (snd_msnd_write_cfg(cfg, IREG_IRQ_TYPE, IRQTYPE_EDGE))
694                 return -EIO;
695         return 0;
696 }
697
698 static int snd_msnd_write_cfg_mem(int cfg, int num, int mem)
699 {
700         u16 wmem;
701
702         mem >>= 8;
703         wmem = (u16)(mem & 0xfff);
704         if (snd_msnd_write_cfg(cfg, IREG_LOGDEVICE, num))
705                 return -EIO;
706         if (snd_msnd_write_cfg(cfg, IREG_MEMBASEHI, HIBYTE(wmem)))
707                 return -EIO;
708         if (snd_msnd_write_cfg(cfg, IREG_MEMBASELO, LOBYTE(wmem)))
709                 return -EIO;
710         if (wmem && snd_msnd_write_cfg(cfg, IREG_MEMCONTROL,
711                                        MEMTYPE_HIADDR | MEMTYPE_16BIT))
712                 return -EIO;
713         return 0;
714 }
715
716 static int snd_msnd_activate_logical(int cfg, int num)
717 {
718         if (snd_msnd_write_cfg(cfg, IREG_LOGDEVICE, num))
719                 return -EIO;
720         if (snd_msnd_write_cfg(cfg, IREG_ACTIVATE, LD_ACTIVATE))
721                 return -EIO;
722         return 0;
723 }
724
725 static int snd_msnd_write_cfg_logical(int cfg, int num, u16 io0,
726                                       u16 io1, u16 irq, int mem)
727 {
728         if (snd_msnd_write_cfg(cfg, IREG_LOGDEVICE, num))
729                 return -EIO;
730         if (snd_msnd_write_cfg_io0(cfg, num, io0))
731                 return -EIO;
732         if (snd_msnd_write_cfg_io1(cfg, num, io1))
733                 return -EIO;
734         if (snd_msnd_write_cfg_irq(cfg, num, irq))
735                 return -EIO;
736         if (snd_msnd_write_cfg_mem(cfg, num, mem))
737                 return -EIO;
738         if (snd_msnd_activate_logical(cfg, num))
739                 return -EIO;
740         return 0;
741 }
742
743 static int snd_msnd_pinnacle_cfg_reset(int cfg)
744 {
745         int i;
746
747         /* Reset devices if told to */
748         printk(KERN_INFO LOGNAME ": Resetting all devices\n");
749         for (i = 0; i < 4; ++i)
750                 if (snd_msnd_write_cfg_logical(cfg, i, 0, 0, 0, 0))
751                         return -EIO;
752
753         return 0;
754 }
755 #endif
756
757 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
758 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
759
760 module_param_array(index, int, NULL, 0444);
761 MODULE_PARM_DESC(index, "Index value for msnd_pinnacle soundcard.");
762 module_param_array(id, charp, NULL, 0444);
763 MODULE_PARM_DESC(id, "ID string for msnd_pinnacle soundcard.");
764
765 static long io[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
766 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
767 static long mem[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
768
769 #ifndef MSND_CLASSIC
770 static long cfg[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
771
772 /* Extra Peripheral Configuration (Default: Disable) */
773 static long ide_io0[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
774 static long ide_io1[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
775 static int ide_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
776
777 static long joystick_io[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
778 /* If we have the digital daugherboard... */
779 static int digital[SNDRV_CARDS];
780
781 /* Extra Peripheral Configuration */
782 static int reset[SNDRV_CARDS];
783 #endif
784
785 static int write_ndelay[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = 1 };
786
787 static int calibrate_signal;
788
789 #ifdef CONFIG_PNP
790 static bool isapnp[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
791 module_param_array(isapnp, bool, NULL, 0444);
792 MODULE_PARM_DESC(isapnp, "ISA PnP detection for specified soundcard.");
793 #define has_isapnp(x) isapnp[x]
794 #else
795 #define has_isapnp(x) 0
796 #endif
797
798 MODULE_AUTHOR("Karsten Wiese <annabellesgarden@yahoo.de>");
799 MODULE_DESCRIPTION("Turtle Beach " LONGNAME " Linux Driver");
800 MODULE_LICENSE("GPL");
801 /*(DEBLOBBED)*/
802
803 module_param_hw_array(io, long, ioport, NULL, 0444);
804 MODULE_PARM_DESC(io, "IO port #");
805 module_param_hw_array(irq, int, irq, NULL, 0444);
806 module_param_hw_array(mem, long, iomem, NULL, 0444);
807 module_param_array(write_ndelay, int, NULL, 0444);
808 module_param(calibrate_signal, int, 0444);
809 #ifndef MSND_CLASSIC
810 module_param_array(digital, int, NULL, 0444);
811 module_param_hw_array(cfg, long, ioport, NULL, 0444);
812 module_param_array(reset, int, NULL, 0444);
813 module_param_hw_array(mpu_io, long, ioport, NULL, 0444);
814 module_param_hw_array(mpu_irq, int, irq, NULL, 0444);
815 module_param_hw_array(ide_io0, long, ioport, NULL, 0444);
816 module_param_hw_array(ide_io1, long, ioport, NULL, 0444);
817 module_param_hw_array(ide_irq, int, irq, NULL, 0444);
818 module_param_hw_array(joystick_io, long, ioport, NULL, 0444);
819 #endif
820
821
822 static int snd_msnd_isa_match(struct device *pdev, unsigned int i)
823 {
824         if (io[i] == SNDRV_AUTO_PORT)
825                 return 0;
826
827         if (irq[i] == SNDRV_AUTO_PORT || mem[i] == SNDRV_AUTO_PORT) {
828                 printk(KERN_WARNING LOGNAME ": io, irq and mem must be set\n");
829                 return 0;
830         }
831
832 #ifdef MSND_CLASSIC
833         if (!(io[i] == 0x290 ||
834               io[i] == 0x260 ||
835               io[i] == 0x250 ||
836               io[i] == 0x240 ||
837               io[i] == 0x230 ||
838               io[i] == 0x220 ||
839               io[i] == 0x210 ||
840               io[i] == 0x3e0)) {
841                 printk(KERN_ERR LOGNAME ": \"io\" - DSP I/O base must be set "
842                         " to 0x210, 0x220, 0x230, 0x240, 0x250, 0x260, 0x290, "
843                         "or 0x3E0\n");
844                 return 0;
845         }
846 #else
847         if (io[i] < 0x100 || io[i] > 0x3e0 || (io[i] % 0x10) != 0) {
848                 printk(KERN_ERR LOGNAME
849                         ": \"io\" - DSP I/O base must within the range 0x100 "
850                         "to 0x3E0 and must be evenly divisible by 0x10\n");
851                 return 0;
852         }
853 #endif /* MSND_CLASSIC */
854
855         if (!(irq[i] == 5 ||
856               irq[i] == 7 ||
857               irq[i] == 9 ||
858               irq[i] == 10 ||
859               irq[i] == 11 ||
860               irq[i] == 12)) {
861                 printk(KERN_ERR LOGNAME
862                         ": \"irq\" - must be set to 5, 7, 9, 10, 11 or 12\n");
863                 return 0;
864         }
865
866         if (!(mem[i] == 0xb0000 ||
867               mem[i] == 0xc8000 ||
868               mem[i] == 0xd0000 ||
869               mem[i] == 0xd8000 ||
870               mem[i] == 0xe0000 ||
871               mem[i] == 0xe8000)) {
872                 printk(KERN_ERR LOGNAME ": \"mem\" - must be set to "
873                        "0xb0000, 0xc8000, 0xd0000, 0xd8000, 0xe0000 or "
874                        "0xe8000\n");
875                 return 0;
876         }
877
878 #ifndef MSND_CLASSIC
879         if (cfg[i] == SNDRV_AUTO_PORT) {
880                 printk(KERN_INFO LOGNAME ": Assuming PnP mode\n");
881         } else if (cfg[i] != 0x250 && cfg[i] != 0x260 && cfg[i] != 0x270) {
882                 printk(KERN_INFO LOGNAME
883                         ": Config port must be 0x250, 0x260 or 0x270 "
884                         "(or unspecified for PnP mode)\n");
885                 return 0;
886         }
887 #endif /* MSND_CLASSIC */
888
889         return 1;
890 }
891
892 static int snd_msnd_isa_probe(struct device *pdev, unsigned int idx)
893 {
894         int err;
895         struct snd_card *card;
896         struct snd_msnd *chip;
897
898         if (has_isapnp(idx)
899 #ifndef MSND_CLASSIC
900             || cfg[idx] == SNDRV_AUTO_PORT
901 #endif
902             ) {
903                 printk(KERN_INFO LOGNAME ": Assuming PnP mode\n");
904                 return -ENODEV;
905         }
906
907         err = snd_card_new(pdev, index[idx], id[idx], THIS_MODULE,
908                            sizeof(struct snd_msnd), &card);
909         if (err < 0)
910                 return err;
911
912         chip = card->private_data;
913         chip->card = card;
914
915 #ifdef MSND_CLASSIC
916         switch (irq[idx]) {
917         case 5:
918                 chip->irqid = HPIRQ_5; break;
919         case 7:
920                 chip->irqid = HPIRQ_7; break;
921         case 9:
922                 chip->irqid = HPIRQ_9; break;
923         case 10:
924                 chip->irqid = HPIRQ_10; break;
925         case 11:
926                 chip->irqid = HPIRQ_11; break;
927         case 12:
928                 chip->irqid = HPIRQ_12; break;
929         }
930
931         switch (mem[idx]) {
932         case 0xb0000:
933                 chip->memid = HPMEM_B000; break;
934         case 0xc8000:
935                 chip->memid = HPMEM_C800; break;
936         case 0xd0000:
937                 chip->memid = HPMEM_D000; break;
938         case 0xd8000:
939                 chip->memid = HPMEM_D800; break;
940         case 0xe0000:
941                 chip->memid = HPMEM_E000; break;
942         case 0xe8000:
943                 chip->memid = HPMEM_E800; break;
944         }
945 #else
946         printk(KERN_INFO LOGNAME ": Non-PnP mode: configuring at port 0x%lx\n",
947                         cfg[idx]);
948
949         if (!request_region(cfg[idx], 2, "Pinnacle/Fiji Config")) {
950                 printk(KERN_ERR LOGNAME ": Config port 0x%lx conflict\n",
951                            cfg[idx]);
952                 snd_card_free(card);
953                 return -EIO;
954         }
955         if (reset[idx])
956                 if (snd_msnd_pinnacle_cfg_reset(cfg[idx])) {
957                         err = -EIO;
958                         goto cfg_error;
959                 }
960
961         /* DSP */
962         err = snd_msnd_write_cfg_logical(cfg[idx], 0,
963                                          io[idx], 0,
964                                          irq[idx], mem[idx]);
965
966         if (err)
967                 goto cfg_error;
968
969         /* The following are Pinnacle specific */
970
971         /* MPU */
972         if (mpu_io[idx] != SNDRV_AUTO_PORT
973             && mpu_irq[idx] != SNDRV_AUTO_IRQ) {
974                 printk(KERN_INFO LOGNAME
975                        ": Configuring MPU to I/O 0x%lx IRQ %d\n",
976                        mpu_io[idx], mpu_irq[idx]);
977                 err = snd_msnd_write_cfg_logical(cfg[idx], 1,
978                                                  mpu_io[idx], 0,
979                                                  mpu_irq[idx], 0);
980
981                 if (err)
982                         goto cfg_error;
983         }
984
985         /* IDE */
986         if (ide_io0[idx] != SNDRV_AUTO_PORT
987             && ide_io1[idx] != SNDRV_AUTO_PORT
988             && ide_irq[idx] != SNDRV_AUTO_IRQ) {
989                 printk(KERN_INFO LOGNAME
990                        ": Configuring IDE to I/O 0x%lx, 0x%lx IRQ %d\n",
991                        ide_io0[idx], ide_io1[idx], ide_irq[idx]);
992                 err = snd_msnd_write_cfg_logical(cfg[idx], 2,
993                                                  ide_io0[idx], ide_io1[idx],
994                                                  ide_irq[idx], 0);
995
996                 if (err)
997                         goto cfg_error;
998         }
999
1000         /* Joystick */
1001         if (joystick_io[idx] != SNDRV_AUTO_PORT) {
1002                 printk(KERN_INFO LOGNAME
1003                        ": Configuring joystick to I/O 0x%lx\n",
1004                        joystick_io[idx]);
1005                 err = snd_msnd_write_cfg_logical(cfg[idx], 3,
1006                                                  joystick_io[idx], 0,
1007                                                  0, 0);
1008
1009                 if (err)
1010                         goto cfg_error;
1011         }
1012         release_region(cfg[idx], 2);
1013
1014 #endif /* MSND_CLASSIC */
1015
1016         set_default_audio_parameters(chip);
1017 #ifdef MSND_CLASSIC
1018         chip->type = msndClassic;
1019 #else
1020         chip->type = msndPinnacle;
1021 #endif
1022         chip->io = io[idx];
1023         chip->irq = irq[idx];
1024         chip->base = mem[idx];
1025
1026         chip->calibrate_signal = calibrate_signal ? 1 : 0;
1027         chip->recsrc = 0;
1028         chip->dspq_data_buff = DSPQ_DATA_BUFF;
1029         chip->dspq_buff_size = DSPQ_BUFF_SIZE;
1030         if (write_ndelay[idx])
1031                 clear_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1032         else
1033                 set_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1034 #ifndef MSND_CLASSIC
1035         if (digital[idx])
1036                 set_bit(F_HAVEDIGITAL, &chip->flags);
1037 #endif
1038         spin_lock_init(&chip->lock);
1039         err = snd_msnd_probe(card);
1040         if (err < 0) {
1041                 printk(KERN_ERR LOGNAME ": Probe failed\n");
1042                 snd_card_free(card);
1043                 return err;
1044         }
1045
1046         err = snd_msnd_attach(card);
1047         if (err < 0) {
1048                 printk(KERN_ERR LOGNAME ": Attach failed\n");
1049                 snd_card_free(card);
1050                 return err;
1051         }
1052         dev_set_drvdata(pdev, card);
1053
1054         return 0;
1055
1056 #ifndef MSND_CLASSIC
1057 cfg_error:
1058         release_region(cfg[idx], 2);
1059         snd_card_free(card);
1060         return err;
1061 #endif
1062 }
1063
1064 static int snd_msnd_isa_remove(struct device *pdev, unsigned int dev)
1065 {
1066         snd_msnd_unload(dev_get_drvdata(pdev));
1067         return 0;
1068 }
1069
1070 static struct isa_driver snd_msnd_driver = {
1071         .match          = snd_msnd_isa_match,
1072         .probe          = snd_msnd_isa_probe,
1073         .remove         = snd_msnd_isa_remove,
1074         /* FIXME: suspend, resume */
1075         .driver         = {
1076                 .name   = DEV_NAME
1077         },
1078 };
1079
1080 #ifdef CONFIG_PNP
1081 static int snd_msnd_pnp_detect(struct pnp_card_link *pcard,
1082                                const struct pnp_card_device_id *pid)
1083 {
1084         static int idx;
1085         struct pnp_dev *pnp_dev;
1086         struct pnp_dev *mpu_dev;
1087         struct snd_card *card;
1088         struct snd_msnd *chip;
1089         int ret;
1090
1091         for ( ; idx < SNDRV_CARDS; idx++) {
1092                 if (has_isapnp(idx))
1093                         break;
1094         }
1095         if (idx >= SNDRV_CARDS)
1096                 return -ENODEV;
1097
1098         /*
1099          * Check that we still have room for another sound card ...
1100          */
1101         pnp_dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1102         if (!pnp_dev)
1103                 return -ENODEV;
1104
1105         mpu_dev = pnp_request_card_device(pcard, pid->devs[1].id, NULL);
1106         if (!mpu_dev)
1107                 return -ENODEV;
1108
1109         if (!pnp_is_active(pnp_dev) && pnp_activate_dev(pnp_dev) < 0) {
1110                 printk(KERN_INFO "msnd_pinnacle: device is inactive\n");
1111                 return -EBUSY;
1112         }
1113
1114         if (!pnp_is_active(mpu_dev) && pnp_activate_dev(mpu_dev) < 0) {
1115                 printk(KERN_INFO "msnd_pinnacle: MPU device is inactive\n");
1116                 return -EBUSY;
1117         }
1118
1119         /*
1120          * Create a new ALSA sound card entry, in anticipation
1121          * of detecting our hardware ...
1122          */
1123         ret = snd_card_new(&pcard->card->dev,
1124                            index[idx], id[idx], THIS_MODULE,
1125                            sizeof(struct snd_msnd), &card);
1126         if (ret < 0)
1127                 return ret;
1128
1129         chip = card->private_data;
1130         chip->card = card;
1131
1132         /*
1133          * Read the correct parameters off the ISA PnP bus ...
1134          */
1135         io[idx] = pnp_port_start(pnp_dev, 0);
1136         irq[idx] = pnp_irq(pnp_dev, 0);
1137         mem[idx] = pnp_mem_start(pnp_dev, 0);
1138         mpu_io[idx] = pnp_port_start(mpu_dev, 0);
1139         mpu_irq[idx] = pnp_irq(mpu_dev, 0);
1140
1141         set_default_audio_parameters(chip);
1142 #ifdef MSND_CLASSIC
1143         chip->type = msndClassic;
1144 #else
1145         chip->type = msndPinnacle;
1146 #endif
1147         chip->io = io[idx];
1148         chip->irq = irq[idx];
1149         chip->base = mem[idx];
1150
1151         chip->calibrate_signal = calibrate_signal ? 1 : 0;
1152         chip->recsrc = 0;
1153         chip->dspq_data_buff = DSPQ_DATA_BUFF;
1154         chip->dspq_buff_size = DSPQ_BUFF_SIZE;
1155         if (write_ndelay[idx])
1156                 clear_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1157         else
1158                 set_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1159 #ifndef MSND_CLASSIC
1160         if (digital[idx])
1161                 set_bit(F_HAVEDIGITAL, &chip->flags);
1162 #endif
1163         spin_lock_init(&chip->lock);
1164         ret = snd_msnd_probe(card);
1165         if (ret < 0) {
1166                 printk(KERN_ERR LOGNAME ": Probe failed\n");
1167                 goto _release_card;
1168         }
1169
1170         ret = snd_msnd_attach(card);
1171         if (ret < 0) {
1172                 printk(KERN_ERR LOGNAME ": Attach failed\n");
1173                 goto _release_card;
1174         }
1175
1176         pnp_set_card_drvdata(pcard, card);
1177         ++idx;
1178         return 0;
1179
1180 _release_card:
1181         snd_card_free(card);
1182         return ret;
1183 }
1184
1185 static void snd_msnd_pnp_remove(struct pnp_card_link *pcard)
1186 {
1187         snd_msnd_unload(pnp_get_card_drvdata(pcard));
1188         pnp_set_card_drvdata(pcard, NULL);
1189 }
1190
1191 static int isa_registered;
1192 static int pnp_registered;
1193
1194 static const struct pnp_card_device_id msnd_pnpids[] = {
1195         /* Pinnacle PnP */
1196         { .id = "BVJ0440", .devs = { { "TBS0000" }, { "TBS0001" } } },
1197         { .id = "" }    /* end */
1198 };
1199
1200 MODULE_DEVICE_TABLE(pnp_card, msnd_pnpids);
1201
1202 static struct pnp_card_driver msnd_pnpc_driver = {
1203         .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1204         .name = "msnd_pinnacle",
1205         .id_table = msnd_pnpids,
1206         .probe = snd_msnd_pnp_detect,
1207         .remove = snd_msnd_pnp_remove,
1208 };
1209 #endif /* CONFIG_PNP */
1210
1211 static int __init snd_msnd_init(void)
1212 {
1213         int err;
1214
1215         err = isa_register_driver(&snd_msnd_driver, SNDRV_CARDS);
1216 #ifdef CONFIG_PNP
1217         if (!err)
1218                 isa_registered = 1;
1219
1220         err = pnp_register_card_driver(&msnd_pnpc_driver);
1221         if (!err)
1222                 pnp_registered = 1;
1223
1224         if (isa_registered)
1225                 err = 0;
1226 #endif
1227         return err;
1228 }
1229
1230 static void __exit snd_msnd_exit(void)
1231 {
1232 #ifdef CONFIG_PNP
1233         if (pnp_registered)
1234                 pnp_unregister_card_driver(&msnd_pnpc_driver);
1235         if (isa_registered)
1236 #endif
1237                 isa_unregister_driver(&snd_msnd_driver);
1238 }
1239
1240 module_init(snd_msnd_init);
1241 module_exit(snd_msnd_exit);
1242