Merge branch 'linaro-android-3.10-lsk' of git://android.git.linaro.org/kernel/linaro...
[firefly-linux-kernel-4.4.55.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 = DEFSAMPLESIZE;
86         chip->play_sample_rate = DEFSAMPLERATE;
87         chip->play_channels = DEFCHANNELS;
88         chip->capture_sample_size = 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 *pwDSPQData = chip->mappedbase + DSPQ_DATA_BUFF;
173
174         /* Send ack to DSP */
175         /* inb(chip->io + HP_RXL); */
176
177         /* Evaluate queued DSP messages */
178         while (readw(chip->DSPQ + JQS_wTail) != readw(chip->DSPQ + JQS_wHead)) {
179                 u16 wTmp;
180
181                 snd_msnd_eval_dsp_msg(chip,
182                         readw(pwDSPQData + 2 * readw(chip->DSPQ + JQS_wHead)));
183
184                 wTmp = readw(chip->DSPQ + JQS_wHead) + 1;
185                 if (wTmp > readw(chip->DSPQ + JQS_wSize))
186                         writew(0, chip->DSPQ + JQS_wHead);
187                 else
188                         writew(wTmp, chip->DSPQ + JQS_wHead);
189         }
190         /* Send ack to DSP */
191         inb(chip->io + HP_RXL);
192         return IRQ_HANDLED;
193 }
194
195
196 static int snd_msnd_reset_dsp(long io, unsigned char *info)
197 {
198         int timeout = 100;
199
200         outb(HPDSPRESET_ON, io + HP_DSPR);
201         msleep(1);
202 #ifndef MSND_CLASSIC
203         if (info)
204                 *info = inb(io + HP_INFO);
205 #endif
206         outb(HPDSPRESET_OFF, io + HP_DSPR);
207         msleep(1);
208         while (timeout-- > 0) {
209                 if (inb(io + HP_CVR) == HP_CVR_DEF)
210                         return 0;
211                 msleep(1);
212         }
213         snd_printk(KERN_ERR LOGNAME ": Cannot reset DSP\n");
214
215         return -EIO;
216 }
217
218 static int snd_msnd_probe(struct snd_card *card)
219 {
220         struct snd_msnd *chip = card->private_data;
221         unsigned char info;
222 #ifndef MSND_CLASSIC
223         char *xv, *rev = NULL;
224         char *pin = "TB Pinnacle", *fiji = "TB Fiji";
225         char *pinfiji = "TB Pinnacle/Fiji";
226 #endif
227
228         if (!request_region(chip->io, DSP_NUMIO, "probing")) {
229                 snd_printk(KERN_ERR LOGNAME ": I/O port conflict\n");
230                 return -ENODEV;
231         }
232
233         if (snd_msnd_reset_dsp(chip->io, &info) < 0) {
234                 release_region(chip->io, DSP_NUMIO);
235                 return -ENODEV;
236         }
237
238 #ifdef MSND_CLASSIC
239         strcpy(card->shortname, "Classic/Tahiti/Monterey");
240         strcpy(card->longname, "Turtle Beach Multisound");
241         printk(KERN_INFO LOGNAME ": %s, "
242                "I/O 0x%lx-0x%lx, IRQ %d, memory mapped to 0x%lX-0x%lX\n",
243                card->shortname,
244                chip->io, chip->io + DSP_NUMIO - 1,
245                chip->irq,
246                chip->base, chip->base + 0x7fff);
247 #else
248         switch (info >> 4) {
249         case 0xf:
250                 xv = "<= 1.15";
251                 break;
252         case 0x1:
253                 xv = "1.18/1.2";
254                 break;
255         case 0x2:
256                 xv = "1.3";
257                 break;
258         case 0x3:
259                 xv = "1.4";
260                 break;
261         default:
262                 xv = "unknown";
263                 break;
264         }
265
266         switch (info & 0x7) {
267         case 0x0:
268                 rev = "I";
269                 strcpy(card->shortname, pin);
270                 break;
271         case 0x1:
272                 rev = "F";
273                 strcpy(card->shortname, pin);
274                 break;
275         case 0x2:
276                 rev = "G";
277                 strcpy(card->shortname, pin);
278                 break;
279         case 0x3:
280                 rev = "H";
281                 strcpy(card->shortname, pin);
282                 break;
283         case 0x4:
284                 rev = "E";
285                 strcpy(card->shortname, fiji);
286                 break;
287         case 0x5:
288                 rev = "C";
289                 strcpy(card->shortname, fiji);
290                 break;
291         case 0x6:
292                 rev = "D";
293                 strcpy(card->shortname, fiji);
294                 break;
295         case 0x7:
296                 rev = "A-B (Fiji) or A-E (Pinnacle)";
297                 strcpy(card->shortname, pinfiji);
298                 break;
299         }
300         strcpy(card->longname, "Turtle Beach Multisound Pinnacle");
301         printk(KERN_INFO LOGNAME ": %s revision %s, Xilinx version %s, "
302                "I/O 0x%lx-0x%lx, IRQ %d, memory mapped to 0x%lX-0x%lX\n",
303                card->shortname,
304                rev, xv,
305                chip->io, chip->io + DSP_NUMIO - 1,
306                chip->irq,
307                chip->base, chip->base + 0x7fff);
308 #endif
309
310         release_region(chip->io, DSP_NUMIO);
311         return 0;
312 }
313
314 static int snd_msnd_init_sma(struct snd_msnd *chip)
315 {
316         static int initted;
317         u16 mastVolLeft, mastVolRight;
318         unsigned long flags;
319
320 #ifdef MSND_CLASSIC
321         outb(chip->memid, chip->io + HP_MEMM);
322 #endif
323         outb(HPBLKSEL_0, chip->io + HP_BLKS);
324         /* Motorola 56k shared memory base */
325         chip->SMA = chip->mappedbase + SMA_STRUCT_START;
326
327         if (initted) {
328                 mastVolLeft = readw(chip->SMA + SMA_wCurrMastVolLeft);
329                 mastVolRight = readw(chip->SMA + SMA_wCurrMastVolRight);
330         } else
331                 mastVolLeft = mastVolRight = 0;
332         memset_io(chip->mappedbase, 0, 0x8000);
333
334         /* Critical section: bank 1 access */
335         spin_lock_irqsave(&chip->lock, flags);
336         outb(HPBLKSEL_1, chip->io + HP_BLKS);
337         memset_io(chip->mappedbase, 0, 0x8000);
338         outb(HPBLKSEL_0, chip->io + HP_BLKS);
339         spin_unlock_irqrestore(&chip->lock, flags);
340
341         /* Digital audio play queue */
342         chip->DAPQ = chip->mappedbase + DAPQ_OFFSET;
343         snd_msnd_init_queue(chip->DAPQ, DAPQ_DATA_BUFF, DAPQ_BUFF_SIZE);
344
345         /* Digital audio record queue */
346         chip->DARQ = chip->mappedbase + DARQ_OFFSET;
347         snd_msnd_init_queue(chip->DARQ, DARQ_DATA_BUFF, DARQ_BUFF_SIZE);
348
349         /* MIDI out queue */
350         chip->MODQ = chip->mappedbase + MODQ_OFFSET;
351         snd_msnd_init_queue(chip->MODQ, MODQ_DATA_BUFF, MODQ_BUFF_SIZE);
352
353         /* MIDI in queue */
354         chip->MIDQ = chip->mappedbase + MIDQ_OFFSET;
355         snd_msnd_init_queue(chip->MIDQ, MIDQ_DATA_BUFF, MIDQ_BUFF_SIZE);
356
357         /* DSP -> host message queue */
358         chip->DSPQ = chip->mappedbase + DSPQ_OFFSET;
359         snd_msnd_init_queue(chip->DSPQ, DSPQ_DATA_BUFF, DSPQ_BUFF_SIZE);
360
361         /* Setup some DSP values */
362 #ifndef MSND_CLASSIC
363         writew(1, chip->SMA + SMA_wCurrPlayFormat);
364         writew(chip->play_sample_size, chip->SMA + SMA_wCurrPlaySampleSize);
365         writew(chip->play_channels, chip->SMA + SMA_wCurrPlayChannels);
366         writew(chip->play_sample_rate, chip->SMA + SMA_wCurrPlaySampleRate);
367 #endif
368         writew(chip->play_sample_rate, chip->SMA + SMA_wCalFreqAtoD);
369         writew(mastVolLeft, chip->SMA + SMA_wCurrMastVolLeft);
370         writew(mastVolRight, chip->SMA + SMA_wCurrMastVolRight);
371 #ifndef MSND_CLASSIC
372         writel(0x00010000, chip->SMA + SMA_dwCurrPlayPitch);
373         writel(0x00000001, chip->SMA + SMA_dwCurrPlayRate);
374 #endif
375         writew(0x303, chip->SMA + SMA_wCurrInputTagBits);
376
377         initted = 1;
378
379         return 0;
380 }
381
382
383 static int upload_dsp_code(struct snd_card *card)
384 {
385         struct snd_msnd *chip = card->private_data;
386         const struct firmware *init_fw = NULL, *perm_fw = NULL;
387         int err;
388
389         outb(HPBLKSEL_0, chip->io + HP_BLKS);
390
391         err = request_firmware(&init_fw, INITCODEFILE, card->dev);
392         if (err < 0) {
393                 printk(KERN_ERR LOGNAME ": Error loading " INITCODEFILE);
394                 goto cleanup1;
395         }
396         err = request_firmware(&perm_fw, PERMCODEFILE, card->dev);
397         if (err < 0) {
398                 printk(KERN_ERR LOGNAME ": Error loading " PERMCODEFILE);
399                 goto cleanup;
400         }
401
402         memcpy_toio(chip->mappedbase, perm_fw->data, perm_fw->size);
403         if (snd_msnd_upload_host(chip, init_fw->data, init_fw->size) < 0) {
404                 printk(KERN_WARNING LOGNAME ": Error uploading to DSP\n");
405                 err = -ENODEV;
406                 goto cleanup;
407         }
408         printk(KERN_INFO LOGNAME ": DSP firmware uploaded\n");
409         err = 0;
410
411 cleanup:
412         release_firmware(perm_fw);
413 cleanup1:
414         release_firmware(init_fw);
415         return err;
416 }
417
418 #ifdef MSND_CLASSIC
419 static void reset_proteus(struct snd_msnd *chip)
420 {
421         outb(HPPRORESET_ON, chip->io + HP_PROR);
422         msleep(TIME_PRO_RESET);
423         outb(HPPRORESET_OFF, chip->io + HP_PROR);
424         msleep(TIME_PRO_RESET_DONE);
425 }
426 #endif
427
428 static int snd_msnd_initialize(struct snd_card *card)
429 {
430         struct snd_msnd *chip = card->private_data;
431         int err, timeout;
432
433 #ifdef MSND_CLASSIC
434         outb(HPWAITSTATE_0, chip->io + HP_WAIT);
435         outb(HPBITMODE_16, chip->io + HP_BITM);
436
437         reset_proteus(chip);
438 #endif
439         err = snd_msnd_init_sma(chip);
440         if (err < 0) {
441                 printk(KERN_WARNING LOGNAME ": Cannot initialize SMA\n");
442                 return err;
443         }
444
445         err = snd_msnd_reset_dsp(chip->io, NULL);
446         if (err < 0)
447                 return err;
448
449         err = upload_dsp_code(card);
450         if (err < 0) {
451                 printk(KERN_WARNING LOGNAME ": Cannot upload DSP code\n");
452                 return err;
453         }
454
455         timeout = 200;
456
457         while (readw(chip->mappedbase)) {
458                 msleep(1);
459                 if (!timeout--) {
460                         snd_printd(KERN_ERR LOGNAME ": DSP reset timeout\n");
461                         return -EIO;
462                 }
463         }
464
465         snd_msndmix_setup(chip);
466         return 0;
467 }
468
469 static int snd_msnd_dsp_full_reset(struct snd_card *card)
470 {
471         struct snd_msnd *chip = card->private_data;
472         int rv;
473
474         if (test_bit(F_RESETTING, &chip->flags) || ++chip->nresets > 10)
475                 return 0;
476
477         set_bit(F_RESETTING, &chip->flags);
478         snd_msnd_dsp_halt(chip, NULL);  /* Unconditionally halt */
479
480         rv = snd_msnd_initialize(card);
481         if (rv)
482                 printk(KERN_WARNING LOGNAME ": DSP reset failed\n");
483         snd_msndmix_force_recsrc(chip, 0);
484         clear_bit(F_RESETTING, &chip->flags);
485         return rv;
486 }
487
488 static int snd_msnd_dev_free(struct snd_device *device)
489 {
490         snd_printdd("snd_msnd_chip_free()\n");
491         return 0;
492 }
493
494 static int snd_msnd_send_dsp_cmd_chk(struct snd_msnd *chip, u8 cmd)
495 {
496         if (snd_msnd_send_dsp_cmd(chip, cmd) == 0)
497                 return 0;
498         snd_msnd_dsp_full_reset(chip->card);
499         return snd_msnd_send_dsp_cmd(chip, cmd);
500 }
501
502 static int snd_msnd_calibrate_adc(struct snd_msnd *chip, u16 srate)
503 {
504         snd_printdd("snd_msnd_calibrate_adc(%i)\n", srate);
505         writew(srate, chip->SMA + SMA_wCalFreqAtoD);
506         if (chip->calibrate_signal == 0)
507                 writew(readw(chip->SMA + SMA_wCurrHostStatusFlags)
508                        | 0x0001, chip->SMA + SMA_wCurrHostStatusFlags);
509         else
510                 writew(readw(chip->SMA + SMA_wCurrHostStatusFlags)
511                        & ~0x0001, chip->SMA + SMA_wCurrHostStatusFlags);
512         if (snd_msnd_send_word(chip, 0, 0, HDEXAR_CAL_A_TO_D) == 0 &&
513             snd_msnd_send_dsp_cmd_chk(chip, HDEX_AUX_REQ) == 0) {
514                 schedule_timeout_interruptible(msecs_to_jiffies(333));
515                 return 0;
516         }
517         printk(KERN_WARNING LOGNAME ": ADC calibration failed\n");
518         return -EIO;
519 }
520
521 /*
522  * ALSA callback function, called when attempting to open the MIDI device.
523  */
524 static int snd_msnd_mpu401_open(struct snd_mpu401 *mpu)
525 {
526         snd_msnd_enable_irq(mpu->private_data);
527         snd_msnd_send_dsp_cmd(mpu->private_data, HDEX_MIDI_IN_START);
528         return 0;
529 }
530
531 static void snd_msnd_mpu401_close(struct snd_mpu401 *mpu)
532 {
533         snd_msnd_send_dsp_cmd(mpu->private_data, HDEX_MIDI_IN_STOP);
534         snd_msnd_disable_irq(mpu->private_data);
535 }
536
537 static long mpu_io[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
538 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
539
540 static int snd_msnd_attach(struct snd_card *card)
541 {
542         struct snd_msnd *chip = card->private_data;
543         int err;
544         static struct snd_device_ops ops = {
545                 .dev_free =      snd_msnd_dev_free,
546                 };
547
548         err = request_irq(chip->irq, snd_msnd_interrupt, 0, card->shortname,
549                           chip);
550         if (err < 0) {
551                 printk(KERN_ERR LOGNAME ": Couldn't grab IRQ %d\n", chip->irq);
552                 return err;
553         }
554         if (request_region(chip->io, DSP_NUMIO, card->shortname) == NULL) {
555                 free_irq(chip->irq, chip);
556                 return -EBUSY;
557         }
558
559         if (!request_mem_region(chip->base, BUFFSIZE, card->shortname)) {
560                 printk(KERN_ERR LOGNAME
561                         ": unable to grab memory region 0x%lx-0x%lx\n",
562                         chip->base, chip->base + BUFFSIZE - 1);
563                 release_region(chip->io, DSP_NUMIO);
564                 free_irq(chip->irq, chip);
565                 return -EBUSY;
566         }
567         chip->mappedbase = ioremap_nocache(chip->base, 0x8000);
568         if (!chip->mappedbase) {
569                 printk(KERN_ERR LOGNAME
570                         ": unable to map memory region 0x%lx-0x%lx\n",
571                         chip->base, chip->base + BUFFSIZE - 1);
572                 err = -EIO;
573                 goto err_release_region;
574         }
575
576         err = snd_msnd_dsp_full_reset(card);
577         if (err < 0)
578                 goto err_release_region;
579
580         /* Register device */
581         err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
582         if (err < 0)
583                 goto err_release_region;
584
585         err = snd_msnd_pcm(card, 0, NULL);
586         if (err < 0) {
587                 printk(KERN_ERR LOGNAME ": error creating new PCM device\n");
588                 goto err_release_region;
589         }
590
591         err = snd_msndmix_new(card);
592         if (err < 0) {
593                 printk(KERN_ERR LOGNAME ": error creating new Mixer device\n");
594                 goto err_release_region;
595         }
596
597
598         if (mpu_io[0] != SNDRV_AUTO_PORT) {
599                 struct snd_mpu401 *mpu;
600
601                 err = snd_mpu401_uart_new(card, 0, MPU401_HW_MPU401,
602                                           mpu_io[0],
603                                           MPU401_MODE_INPUT |
604                                           MPU401_MODE_OUTPUT,
605                                           mpu_irq[0],
606                                           &chip->rmidi);
607                 if (err < 0) {
608                         printk(KERN_ERR LOGNAME
609                                 ": error creating new Midi device\n");
610                         goto err_release_region;
611                 }
612                 mpu = chip->rmidi->private_data;
613
614                 mpu->open_input = snd_msnd_mpu401_open;
615                 mpu->close_input = snd_msnd_mpu401_close;
616                 mpu->private_data = chip;
617         }
618
619         disable_irq(chip->irq);
620         snd_msnd_calibrate_adc(chip, chip->play_sample_rate);
621         snd_msndmix_force_recsrc(chip, 0);
622
623         err = snd_card_register(card);
624         if (err < 0)
625                 goto err_release_region;
626
627         return 0;
628
629 err_release_region:
630         if (chip->mappedbase)
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, S_IRUGO);
761 MODULE_PARM_DESC(index, "Index value for msnd_pinnacle soundcard.");
762 module_param_array(id, charp, NULL, S_IRUGO);
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 MODULE_FIRMWARE(INITCODEFILE);
802 MODULE_FIRMWARE(PERMCODEFILE);
803
804 module_param_array(io, long, NULL, S_IRUGO);
805 MODULE_PARM_DESC(io, "IO port #");
806 module_param_array(irq, int, NULL, S_IRUGO);
807 module_param_array(mem, long, NULL, S_IRUGO);
808 module_param_array(write_ndelay, int, NULL, S_IRUGO);
809 module_param(calibrate_signal, int, S_IRUGO);
810 #ifndef MSND_CLASSIC
811 module_param_array(digital, int, NULL, S_IRUGO);
812 module_param_array(cfg, long, NULL, S_IRUGO);
813 module_param_array(reset, int, 0, S_IRUGO);
814 module_param_array(mpu_io, long, NULL, S_IRUGO);
815 module_param_array(mpu_irq, int, NULL, S_IRUGO);
816 module_param_array(ide_io0, long, NULL, S_IRUGO);
817 module_param_array(ide_io1, long, NULL, S_IRUGO);
818 module_param_array(ide_irq, int, NULL, S_IRUGO);
819 module_param_array(joystick_io, long, NULL, S_IRUGO);
820 #endif
821
822
823 static int snd_msnd_isa_match(struct device *pdev, unsigned int i)
824 {
825         if (io[i] == SNDRV_AUTO_PORT)
826                 return 0;
827
828         if (irq[i] == SNDRV_AUTO_PORT || mem[i] == SNDRV_AUTO_PORT) {
829                 printk(KERN_WARNING LOGNAME ": io, irq and mem must be set\n");
830                 return 0;
831         }
832
833 #ifdef MSND_CLASSIC
834         if (!(io[i] == 0x290 ||
835               io[i] == 0x260 ||
836               io[i] == 0x250 ||
837               io[i] == 0x240 ||
838               io[i] == 0x230 ||
839               io[i] == 0x220 ||
840               io[i] == 0x210 ||
841               io[i] == 0x3e0)) {
842                 printk(KERN_ERR LOGNAME ": \"io\" - DSP I/O base must be set "
843                         " to 0x210, 0x220, 0x230, 0x240, 0x250, 0x260, 0x290, "
844                         "or 0x3E0\n");
845                 return 0;
846         }
847 #else
848         if (io[i] < 0x100 || io[i] > 0x3e0 || (io[i] % 0x10) != 0) {
849                 printk(KERN_ERR LOGNAME
850                         ": \"io\" - DSP I/O base must within the range 0x100 "
851                         "to 0x3E0 and must be evenly divisible by 0x10\n");
852                 return 0;
853         }
854 #endif /* MSND_CLASSIC */
855
856         if (!(irq[i] == 5 ||
857               irq[i] == 7 ||
858               irq[i] == 9 ||
859               irq[i] == 10 ||
860               irq[i] == 11 ||
861               irq[i] == 12)) {
862                 printk(KERN_ERR LOGNAME
863                         ": \"irq\" - must be set to 5, 7, 9, 10, 11 or 12\n");
864                 return 0;
865         }
866
867         if (!(mem[i] == 0xb0000 ||
868               mem[i] == 0xc8000 ||
869               mem[i] == 0xd0000 ||
870               mem[i] == 0xd8000 ||
871               mem[i] == 0xe0000 ||
872               mem[i] == 0xe8000)) {
873                 printk(KERN_ERR LOGNAME ": \"mem\" - must be set to "
874                        "0xb0000, 0xc8000, 0xd0000, 0xd8000, 0xe0000 or "
875                        "0xe8000\n");
876                 return 0;
877         }
878
879 #ifndef MSND_CLASSIC
880         if (cfg[i] == SNDRV_AUTO_PORT) {
881                 printk(KERN_INFO LOGNAME ": Assuming PnP mode\n");
882         } else if (cfg[i] != 0x250 && cfg[i] != 0x260 && cfg[i] != 0x270) {
883                 printk(KERN_INFO LOGNAME
884                         ": Config port must be 0x250, 0x260 or 0x270 "
885                         "(or unspecified for PnP mode)\n");
886                 return 0;
887         }
888 #endif /* MSND_CLASSIC */
889
890         return 1;
891 }
892
893 static int snd_msnd_isa_probe(struct device *pdev, unsigned int idx)
894 {
895         int err;
896         struct snd_card *card;
897         struct snd_msnd *chip;
898
899         if (has_isapnp(idx)
900 #ifndef MSND_CLASSIC
901             || cfg[idx] == SNDRV_AUTO_PORT
902 #endif
903             ) {
904                 printk(KERN_INFO LOGNAME ": Assuming PnP mode\n");
905                 return -ENODEV;
906         }
907
908         err = snd_card_create(index[idx], id[idx], THIS_MODULE,
909                               sizeof(struct snd_msnd), &card);
910         if (err < 0)
911                 return err;
912
913         snd_card_set_dev(card, pdev);
914         chip = card->private_data;
915         chip->card = card;
916
917 #ifdef MSND_CLASSIC
918         switch (irq[idx]) {
919         case 5:
920                 chip->irqid = HPIRQ_5; break;
921         case 7:
922                 chip->irqid = HPIRQ_7; break;
923         case 9:
924                 chip->irqid = HPIRQ_9; break;
925         case 10:
926                 chip->irqid = HPIRQ_10; break;
927         case 11:
928                 chip->irqid = HPIRQ_11; break;
929         case 12:
930                 chip->irqid = HPIRQ_12; break;
931         }
932
933         switch (mem[idx]) {
934         case 0xb0000:
935                 chip->memid = HPMEM_B000; break;
936         case 0xc8000:
937                 chip->memid = HPMEM_C800; break;
938         case 0xd0000:
939                 chip->memid = HPMEM_D000; break;
940         case 0xd8000:
941                 chip->memid = HPMEM_D800; break;
942         case 0xe0000:
943                 chip->memid = HPMEM_E000; break;
944         case 0xe8000:
945                 chip->memid = HPMEM_E800; break;
946         }
947 #else
948         printk(KERN_INFO LOGNAME ": Non-PnP mode: configuring at port 0x%lx\n",
949                         cfg[idx]);
950
951         if (!request_region(cfg[idx], 2, "Pinnacle/Fiji Config")) {
952                 printk(KERN_ERR LOGNAME ": Config port 0x%lx conflict\n",
953                            cfg[idx]);
954                 snd_card_free(card);
955                 return -EIO;
956         }
957         if (reset[idx])
958                 if (snd_msnd_pinnacle_cfg_reset(cfg[idx])) {
959                         err = -EIO;
960                         goto cfg_error;
961                 }
962
963         /* DSP */
964         err = snd_msnd_write_cfg_logical(cfg[idx], 0,
965                                          io[idx], 0,
966                                          irq[idx], mem[idx]);
967
968         if (err)
969                 goto cfg_error;
970
971         /* The following are Pinnacle specific */
972
973         /* MPU */
974         if (mpu_io[idx] != SNDRV_AUTO_PORT
975             && mpu_irq[idx] != SNDRV_AUTO_IRQ) {
976                 printk(KERN_INFO LOGNAME
977                        ": Configuring MPU to I/O 0x%lx IRQ %d\n",
978                        mpu_io[idx], mpu_irq[idx]);
979                 err = snd_msnd_write_cfg_logical(cfg[idx], 1,
980                                                  mpu_io[idx], 0,
981                                                  mpu_irq[idx], 0);
982
983                 if (err)
984                         goto cfg_error;
985         }
986
987         /* IDE */
988         if (ide_io0[idx] != SNDRV_AUTO_PORT
989             && ide_io1[idx] != SNDRV_AUTO_PORT
990             && ide_irq[idx] != SNDRV_AUTO_IRQ) {
991                 printk(KERN_INFO LOGNAME
992                        ": Configuring IDE to I/O 0x%lx, 0x%lx IRQ %d\n",
993                        ide_io0[idx], ide_io1[idx], ide_irq[idx]);
994                 err = snd_msnd_write_cfg_logical(cfg[idx], 2,
995                                                  ide_io0[idx], ide_io1[idx],
996                                                  ide_irq[idx], 0);
997
998                 if (err)
999                         goto cfg_error;
1000         }
1001
1002         /* Joystick */
1003         if (joystick_io[idx] != SNDRV_AUTO_PORT) {
1004                 printk(KERN_INFO LOGNAME
1005                        ": Configuring joystick to I/O 0x%lx\n",
1006                        joystick_io[idx]);
1007                 err = snd_msnd_write_cfg_logical(cfg[idx], 3,
1008                                                  joystick_io[idx], 0,
1009                                                  0, 0);
1010
1011                 if (err)
1012                         goto cfg_error;
1013         }
1014         release_region(cfg[idx], 2);
1015
1016 #endif /* MSND_CLASSIC */
1017
1018         set_default_audio_parameters(chip);
1019 #ifdef MSND_CLASSIC
1020         chip->type = msndClassic;
1021 #else
1022         chip->type = msndPinnacle;
1023 #endif
1024         chip->io = io[idx];
1025         chip->irq = irq[idx];
1026         chip->base = mem[idx];
1027
1028         chip->calibrate_signal = calibrate_signal ? 1 : 0;
1029         chip->recsrc = 0;
1030         chip->dspq_data_buff = DSPQ_DATA_BUFF;
1031         chip->dspq_buff_size = DSPQ_BUFF_SIZE;
1032         if (write_ndelay[idx])
1033                 clear_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1034         else
1035                 set_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1036 #ifndef MSND_CLASSIC
1037         if (digital[idx])
1038                 set_bit(F_HAVEDIGITAL, &chip->flags);
1039 #endif
1040         spin_lock_init(&chip->lock);
1041         err = snd_msnd_probe(card);
1042         if (err < 0) {
1043                 printk(KERN_ERR LOGNAME ": Probe failed\n");
1044                 snd_card_free(card);
1045                 return err;
1046         }
1047
1048         err = snd_msnd_attach(card);
1049         if (err < 0) {
1050                 printk(KERN_ERR LOGNAME ": Attach failed\n");
1051                 snd_card_free(card);
1052                 return err;
1053         }
1054         dev_set_drvdata(pdev, card);
1055
1056         return 0;
1057
1058 #ifndef MSND_CLASSIC
1059 cfg_error:
1060         release_region(cfg[idx], 2);
1061         snd_card_free(card);
1062         return err;
1063 #endif
1064 }
1065
1066 static int snd_msnd_isa_remove(struct device *pdev, unsigned int dev)
1067 {
1068         snd_msnd_unload(dev_get_drvdata(pdev));
1069         dev_set_drvdata(pdev, NULL);
1070         return 0;
1071 }
1072
1073 static struct isa_driver snd_msnd_driver = {
1074         .match          = snd_msnd_isa_match,
1075         .probe          = snd_msnd_isa_probe,
1076         .remove         = snd_msnd_isa_remove,
1077         /* FIXME: suspend, resume */
1078         .driver         = {
1079                 .name   = DEV_NAME
1080         },
1081 };
1082
1083 #ifdef CONFIG_PNP
1084 static int snd_msnd_pnp_detect(struct pnp_card_link *pcard,
1085                                const struct pnp_card_device_id *pid)
1086 {
1087         static int idx;
1088         struct pnp_dev *pnp_dev;
1089         struct pnp_dev *mpu_dev;
1090         struct snd_card *card;
1091         struct snd_msnd *chip;
1092         int ret;
1093
1094         for ( ; idx < SNDRV_CARDS; idx++) {
1095                 if (has_isapnp(idx))
1096                         break;
1097         }
1098         if (idx >= SNDRV_CARDS)
1099                 return -ENODEV;
1100
1101         /*
1102          * Check that we still have room for another sound card ...
1103          */
1104         pnp_dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1105         if (!pnp_dev)
1106                 return -ENODEV;
1107
1108         mpu_dev = pnp_request_card_device(pcard, pid->devs[1].id, NULL);
1109         if (!mpu_dev)
1110                 return -ENODEV;
1111
1112         if (!pnp_is_active(pnp_dev) && pnp_activate_dev(pnp_dev) < 0) {
1113                 printk(KERN_INFO "msnd_pinnacle: device is inactive\n");
1114                 return -EBUSY;
1115         }
1116
1117         if (!pnp_is_active(mpu_dev) && pnp_activate_dev(mpu_dev) < 0) {
1118                 printk(KERN_INFO "msnd_pinnacle: MPU device is inactive\n");
1119                 return -EBUSY;
1120         }
1121
1122         /*
1123          * Create a new ALSA sound card entry, in anticipation
1124          * of detecting our hardware ...
1125          */
1126         ret = snd_card_create(index[idx], id[idx], THIS_MODULE,
1127                               sizeof(struct snd_msnd), &card);
1128         if (ret < 0)
1129                 return ret;
1130
1131         chip = card->private_data;
1132         chip->card = card;
1133         snd_card_set_dev(card, &pcard->card->dev);
1134
1135         /*
1136          * Read the correct parameters off the ISA PnP bus ...
1137          */
1138         io[idx] = pnp_port_start(pnp_dev, 0);
1139         irq[idx] = pnp_irq(pnp_dev, 0);
1140         mem[idx] = pnp_mem_start(pnp_dev, 0);
1141         mpu_io[idx] = pnp_port_start(mpu_dev, 0);
1142         mpu_irq[idx] = pnp_irq(mpu_dev, 0);
1143
1144         set_default_audio_parameters(chip);
1145 #ifdef MSND_CLASSIC
1146         chip->type = msndClassic;
1147 #else
1148         chip->type = msndPinnacle;
1149 #endif
1150         chip->io = io[idx];
1151         chip->irq = irq[idx];
1152         chip->base = mem[idx];
1153
1154         chip->calibrate_signal = calibrate_signal ? 1 : 0;
1155         chip->recsrc = 0;
1156         chip->dspq_data_buff = DSPQ_DATA_BUFF;
1157         chip->dspq_buff_size = DSPQ_BUFF_SIZE;
1158         if (write_ndelay[idx])
1159                 clear_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1160         else
1161                 set_bit(F_DISABLE_WRITE_NDELAY, &chip->flags);
1162 #ifndef MSND_CLASSIC
1163         if (digital[idx])
1164                 set_bit(F_HAVEDIGITAL, &chip->flags);
1165 #endif
1166         spin_lock_init(&chip->lock);
1167         ret = snd_msnd_probe(card);
1168         if (ret < 0) {
1169                 printk(KERN_ERR LOGNAME ": Probe failed\n");
1170                 goto _release_card;
1171         }
1172
1173         ret = snd_msnd_attach(card);
1174         if (ret < 0) {
1175                 printk(KERN_ERR LOGNAME ": Attach failed\n");
1176                 goto _release_card;
1177         }
1178
1179         pnp_set_card_drvdata(pcard, card);
1180         ++idx;
1181         return 0;
1182
1183 _release_card:
1184         snd_card_free(card);
1185         return ret;
1186 }
1187
1188 static void snd_msnd_pnp_remove(struct pnp_card_link *pcard)
1189 {
1190         snd_msnd_unload(pnp_get_card_drvdata(pcard));
1191         pnp_set_card_drvdata(pcard, NULL);
1192 }
1193
1194 static int isa_registered;
1195 static int pnp_registered;
1196
1197 static struct pnp_card_device_id msnd_pnpids[] = {
1198         /* Pinnacle PnP */
1199         { .id = "BVJ0440", .devs = { { "TBS0000" }, { "TBS0001" } } },
1200         { .id = "" }    /* end */
1201 };
1202
1203 MODULE_DEVICE_TABLE(pnp_card, msnd_pnpids);
1204
1205 static struct pnp_card_driver msnd_pnpc_driver = {
1206         .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1207         .name = "msnd_pinnacle",
1208         .id_table = msnd_pnpids,
1209         .probe = snd_msnd_pnp_detect,
1210         .remove = snd_msnd_pnp_remove,
1211 };
1212 #endif /* CONFIG_PNP */
1213
1214 static int __init snd_msnd_init(void)
1215 {
1216         int err;
1217
1218         err = isa_register_driver(&snd_msnd_driver, SNDRV_CARDS);
1219 #ifdef CONFIG_PNP
1220         if (!err)
1221                 isa_registered = 1;
1222
1223         err = pnp_register_card_driver(&msnd_pnpc_driver);
1224         if (!err)
1225                 pnp_registered = 1;
1226
1227         if (isa_registered)
1228                 err = 0;
1229 #endif
1230         return err;
1231 }
1232
1233 static void __exit snd_msnd_exit(void)
1234 {
1235 #ifdef CONFIG_PNP
1236         if (pnp_registered)
1237                 pnp_unregister_card_driver(&msnd_pnpc_driver);
1238         if (isa_registered)
1239 #endif
1240                 isa_unregister_driver(&snd_msnd_driver);
1241 }
1242
1243 module_init(snd_msnd_init);
1244 module_exit(snd_msnd_exit);
1245