GNU Linux-libre 4.4.284-gnu1
[releases.git] / sound / isa / sscape.c
1 /*
2  *   Low-level ALSA driver for the ENSONIQ SoundScape
3  *   Copyright (c) by Chris Rankin
4  *
5  *   This driver was written in part using information obtained from
6  *   the OSS/Free SoundScape driver, written by Hannu Savolainen.
7  *
8  *
9  *   This program is free software; you can redistribute it and/or modify
10  *   it under the terms of the GNU General Public License as published by
11  *   the Free Software Foundation; either version 2 of the License, or
12  *   (at your option) any later version.
13  *
14  *   This program is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with this program; if not, write to the Free Software
21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22  */
23
24 #include <linux/init.h>
25 #include <linux/err.h>
26 #include <linux/io.h>
27 #include <linux/isa.h>
28 #include <linux/delay.h>
29 #include <linux/firmware.h>
30 #include <linux/pnp.h>
31 #include <linux/spinlock.h>
32 #include <linux/module.h>
33 #include <asm/dma.h>
34 #include <sound/core.h>
35 #include <sound/wss.h>
36 #include <sound/mpu401.h>
37 #include <sound/initval.h>
38
39
40 MODULE_AUTHOR("Chris Rankin");
41 MODULE_DESCRIPTION("ENSONIQ SoundScape driver");
42 MODULE_LICENSE("GPL");
43 /*(DEBLOBBED)*/
44
45 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
46 static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
47 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
48 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
49 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
50 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;
51 static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
52 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
53 static bool joystick[SNDRV_CARDS];
54
55 module_param_array(index, int, NULL, 0444);
56 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
57
58 module_param_array(id, charp, NULL, 0444);
59 MODULE_PARM_DESC(id, "Description for SoundScape card");
60
61 module_param_array(port, long, NULL, 0444);
62 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
63
64 module_param_array(wss_port, long, NULL, 0444);
65 MODULE_PARM_DESC(wss_port, "WSS Port # for SoundScape driver.");
66
67 module_param_array(irq, int, NULL, 0444);
68 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
69
70 module_param_array(mpu_irq, int, NULL, 0444);
71 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
72
73 module_param_array(dma, int, NULL, 0444);
74 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
75
76 module_param_array(dma2, int, NULL, 0444);
77 MODULE_PARM_DESC(dma2, "DMA2 # for SoundScape driver.");
78
79 module_param_array(joystick, bool, NULL, 0444);
80 MODULE_PARM_DESC(joystick, "Enable gameport.");
81
82 #ifdef CONFIG_PNP
83 static int isa_registered;
84 static int pnp_registered;
85
86 static struct pnp_card_device_id sscape_pnpids[] = {
87         { .id = "ENS3081", .devs = { { "ENS0000" } } }, /* Soundscape PnP */
88         { .id = "ENS4081", .devs = { { "ENS1011" } } }, /* VIVO90 */
89         { .id = "" }    /* end */
90 };
91
92 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
93 #endif
94
95
96 #define HOST_CTRL_IO(i)  ((i) + 2)
97 #define HOST_DATA_IO(i)  ((i) + 3)
98 #define ODIE_ADDR_IO(i)  ((i) + 4)
99 #define ODIE_DATA_IO(i)  ((i) + 5)
100 #define CODEC_IO(i)      ((i) + 8)
101
102 #define IC_ODIE  1
103 #define IC_OPUS  2
104
105 #define RX_READY 0x01
106 #define TX_READY 0x02
107
108 #define CMD_ACK                 0x80
109 #define CMD_SET_MIDI_VOL        0x84
110 #define CMD_GET_MIDI_VOL        0x85
111 #define CMD_XXX_MIDI_VOL        0x86
112 #define CMD_SET_EXTMIDI         0x8a
113 #define CMD_GET_EXTMIDI         0x8b
114 #define CMD_SET_MT32            0x8c
115 #define CMD_GET_MT32            0x8d
116
117 enum GA_REG {
118         GA_INTSTAT_REG = 0,
119         GA_INTENA_REG,
120         GA_DMAA_REG,
121         GA_DMAB_REG,
122         GA_INTCFG_REG,
123         GA_DMACFG_REG,
124         GA_CDCFG_REG,
125         GA_SMCFGA_REG,
126         GA_SMCFGB_REG,
127         GA_HMCTL_REG
128 };
129
130 #define DMA_8BIT  0x80
131
132
133 enum card_type {
134         MEDIA_FX,       /* Sequoia S-1000 */
135         SSCAPE,         /* Sequoia S-2000 */
136         SSCAPE_PNP,
137         SSCAPE_VIVO,
138 };
139
140 struct soundscape {
141         spinlock_t lock;
142         unsigned io_base;
143         int ic_type;
144         enum card_type type;
145         struct resource *io_res;
146         struct resource *wss_res;
147         struct snd_wss *chip;
148
149         unsigned char midi_vol;
150 };
151
152 #define INVALID_IRQ  ((unsigned)-1)
153
154
155 static inline struct soundscape *get_card_soundscape(struct snd_card *c)
156 {
157         return (struct soundscape *) (c->private_data);
158 }
159
160 /*
161  * Allocates some kernel memory that we can use for DMA.
162  * I think this means that the memory has to map to
163  * contiguous pages of physical memory.
164  */
165 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf,
166                                          unsigned long size)
167 {
168         if (buf) {
169                 if (snd_dma_alloc_pages_fallback(SNDRV_DMA_TYPE_DEV,
170                                                  snd_dma_isa_data(),
171                                                  size, buf) < 0) {
172                         snd_printk(KERN_ERR "sscape: Failed to allocate "
173                                             "%lu bytes for DMA\n",
174                                             size);
175                         return NULL;
176                 }
177         }
178
179         return buf;
180 }
181
182 /*
183  * Release the DMA-able kernel memory ...
184  */
185 static void free_dmabuf(struct snd_dma_buffer *buf)
186 {
187         if (buf && buf->area)
188                 snd_dma_free_pages(buf);
189 }
190
191 /*
192  * This function writes to the SoundScape's control registers,
193  * but doesn't do any locking. It's up to the caller to do that.
194  * This is why this function is "unsafe" ...
195  */
196 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg,
197                                        unsigned char val)
198 {
199         outb(reg, ODIE_ADDR_IO(io_base));
200         outb(val, ODIE_DATA_IO(io_base));
201 }
202
203 /*
204  * Write to the SoundScape's control registers, and do the
205  * necessary locking ...
206  */
207 static void sscape_write(struct soundscape *s, enum GA_REG reg,
208                          unsigned char val)
209 {
210         unsigned long flags;
211
212         spin_lock_irqsave(&s->lock, flags);
213         sscape_write_unsafe(s->io_base, reg, val);
214         spin_unlock_irqrestore(&s->lock, flags);
215 }
216
217 /*
218  * Read from the SoundScape's control registers, but leave any
219  * locking to the caller. This is why the function is "unsafe" ...
220  */
221 static inline unsigned char sscape_read_unsafe(unsigned io_base,
222                                                enum GA_REG reg)
223 {
224         outb(reg, ODIE_ADDR_IO(io_base));
225         return inb(ODIE_DATA_IO(io_base));
226 }
227
228 /*
229  * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
230  */
231 static inline void set_host_mode_unsafe(unsigned io_base)
232 {
233         outb(0x0, HOST_CTRL_IO(io_base));
234 }
235
236 /*
237  * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
238  */
239 static inline void set_midi_mode_unsafe(unsigned io_base)
240 {
241         outb(0x3, HOST_CTRL_IO(io_base));
242 }
243
244 /*
245  * Read the SoundScape's host-mode control register, but leave
246  * any locking issues to the caller ...
247  */
248 static inline int host_read_unsafe(unsigned io_base)
249 {
250         int data = -1;
251         if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0)
252                 data = inb(HOST_DATA_IO(io_base));
253
254         return data;
255 }
256
257 /*
258  * Read the SoundScape's host-mode control register, performing
259  * a limited amount of busy-waiting if the register isn't ready.
260  * Also leaves all locking-issues to the caller ...
261  */
262 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
263 {
264         int data;
265
266         while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
267                 udelay(100);
268                 --timeout;
269         } /* while */
270
271         return data;
272 }
273
274 /*
275  * Write to the SoundScape's host-mode control registers, but
276  * leave any locking issues to the caller ...
277  */
278 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
279 {
280         if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
281                 outb(data, HOST_DATA_IO(io_base));
282                 return 1;
283         }
284
285         return 0;
286 }
287
288 /*
289  * Write to the SoundScape's host-mode control registers, performing
290  * a limited amount of busy-waiting if the register isn't ready.
291  * Also leaves all locking-issues to the caller ...
292  */
293 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
294                                   unsigned timeout)
295 {
296         int err;
297
298         while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
299                 udelay(100);
300                 --timeout;
301         } /* while */
302
303         return err;
304 }
305
306
307 /*
308  * Check that the MIDI subsystem is operational. If it isn't,
309  * then we will hang the computer if we try to use it ...
310  *
311  * NOTE: This check is based upon observation, not documentation.
312  */
313 static inline int verify_mpu401(const struct snd_mpu401 *mpu)
314 {
315         return ((inb(MPU401C(mpu)) & 0xc0) == 0x80);
316 }
317
318 /*
319  * This is apparently the standard way to initailise an MPU-401
320  */
321 static inline void initialise_mpu401(const struct snd_mpu401 *mpu)
322 {
323         outb(0, MPU401D(mpu));
324 }
325
326 /*
327  * Tell the SoundScape to activate the AD1845 chip (I think).
328  * The AD1845 detection fails if we *don't* do this, so I
329  * think that this is a good idea ...
330  */
331 static void activate_ad1845_unsafe(unsigned io_base)
332 {
333         unsigned char val = sscape_read_unsafe(io_base, GA_HMCTL_REG);
334         sscape_write_unsafe(io_base, GA_HMCTL_REG, (val & 0xcf) | 0x10);
335         sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
336 }
337
338 /*
339  * Do the necessary ALSA-level cleanup to deallocate our driver ...
340  */
341 static void soundscape_free(struct snd_card *c)
342 {
343         struct soundscape *sscape = get_card_soundscape(c);
344         release_and_free_resource(sscape->io_res);
345         release_and_free_resource(sscape->wss_res);
346         free_dma(sscape->chip->dma1);
347 }
348
349 /*
350  * Tell the SoundScape to begin a DMA tranfer using the given channel.
351  * All locking issues are left to the caller.
352  */
353 static void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
354 {
355         sscape_write_unsafe(io_base, reg,
356                             sscape_read_unsafe(io_base, reg) | 0x01);
357         sscape_write_unsafe(io_base, reg,
358                             sscape_read_unsafe(io_base, reg) & 0xfe);
359 }
360
361 /*
362  * Wait for a DMA transfer to complete. This is a "limited busy-wait",
363  * and all locking issues are left to the caller.
364  */
365 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg,
366                                   unsigned timeout)
367 {
368         while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
369                 udelay(100);
370                 --timeout;
371         } /* while */
372
373         return sscape_read_unsafe(io_base, reg) & 0x01;
374 }
375
376 /*
377  * Wait for the On-Board Processor to return its start-up
378  * acknowledgement sequence. This wait is too long for
379  * us to perform "busy-waiting", and so we must sleep.
380  * This in turn means that we must not be holding any
381  * spinlocks when we call this function.
382  */
383 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
384 {
385         unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
386
387         do {
388                 unsigned long flags;
389                 int x;
390
391                 spin_lock_irqsave(&s->lock, flags);
392                 x = host_read_unsafe(s->io_base);
393                 spin_unlock_irqrestore(&s->lock, flags);
394                 if (x == 0xfe || x == 0xff)
395                         return 1;
396
397                 msleep(10);
398         } while (time_before(jiffies, end_time));
399
400         return 0;
401 }
402
403 /*
404  * Wait for the host to return its start-up acknowledgement
405  * sequence. This wait is too long for us to perform
406  * "busy-waiting", and so we must sleep. This in turn means
407  * that we must not be holding any spinlocks when we call
408  * this function.
409  */
410 static int host_startup_ack(struct soundscape *s, unsigned timeout)
411 {
412         unsigned long end_time = jiffies + msecs_to_jiffies(timeout);
413
414         do {
415                 unsigned long flags;
416                 int x;
417
418                 spin_lock_irqsave(&s->lock, flags);
419                 x = host_read_unsafe(s->io_base);
420                 spin_unlock_irqrestore(&s->lock, flags);
421                 if (x == 0xfe)
422                         return 1;
423
424                 msleep(10);
425         } while (time_before(jiffies, end_time));
426
427         return 0;
428 }
429
430 /*
431  * Upload a byte-stream into the SoundScape using DMA channel A.
432  */
433 static int upload_dma_data(struct soundscape *s, const unsigned char *data,
434                            size_t size)
435 {
436         unsigned long flags;
437         struct snd_dma_buffer dma;
438         int ret;
439         unsigned char val;
440
441         if (!get_dmabuf(&dma, PAGE_ALIGN(32 * 1024)))
442                 return -ENOMEM;
443
444         spin_lock_irqsave(&s->lock, flags);
445
446         /*
447          * Reset the board ...
448          */
449         val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
450         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val & 0x3f);
451
452         /*
453          * Enable the DMA channels and configure them ...
454          */
455         val = (s->chip->dma1 << 4) | DMA_8BIT;
456         sscape_write_unsafe(s->io_base, GA_DMAA_REG, val);
457         sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
458
459         /*
460          * Take the board out of reset ...
461          */
462         val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
463         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x80);
464
465         /*
466          * Upload the firmware to the SoundScape
467          * board through the DMA channel ...
468          */
469         while (size != 0) {
470                 unsigned long len;
471
472                 len = min(size, dma.bytes);
473                 memcpy(dma.area, data, len);
474                 data += len;
475                 size -= len;
476
477                 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
478                 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
479                 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
480                         /*
481                          * Don't forget to release this spinlock we're holding
482                          */
483                         spin_unlock_irqrestore(&s->lock, flags);
484
485                         snd_printk(KERN_ERR
486                                         "sscape: DMA upload has timed out\n");
487                         ret = -EAGAIN;
488                         goto _release_dma;
489                 }
490         } /* while */
491
492         set_host_mode_unsafe(s->io_base);
493         outb(0x0, s->io_base);
494
495         /*
496          * Boot the board ... (I think)
497          */
498         val = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
499         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, val | 0x40);
500         spin_unlock_irqrestore(&s->lock, flags);
501
502         /*
503          * If all has gone well, then the board should acknowledge
504          * the new upload and tell us that it has rebooted OK. We
505          * give it 5 seconds (max) ...
506          */
507         ret = 0;
508         if (!obp_startup_ack(s, 5000)) {
509                 snd_printk(KERN_ERR "sscape: No response "
510                                     "from on-board processor after upload\n");
511                 ret = -EAGAIN;
512         } else if (!host_startup_ack(s, 5000)) {
513                 snd_printk(KERN_ERR
514                                 "sscape: SoundScape failed to initialise\n");
515                 ret = -EAGAIN;
516         }
517
518 _release_dma:
519         /*
520          * NOTE!!! We are NOT holding any spinlocks at this point !!!
521          */
522         sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_OPUS ? 0x40 : 0x70));
523         free_dmabuf(&dma);
524
525         return ret;
526 }
527
528 /*
529  * Upload the bootblock(?) into the SoundScape. The only
530  * purpose of this block of code seems to be to tell
531  * us which version of the microcode we should be using.
532  */
533 static int sscape_upload_bootblock(struct snd_card *card)
534 {
535         struct soundscape *sscape = get_card_soundscape(card);
536         unsigned long flags;
537         const struct firmware *init_fw = NULL;
538         int data = 0;
539         int ret;
540
541         ret = reject_firmware(&init_fw, "/*(DEBLOBBED)*/", card->dev);
542         if (ret < 0) {
543                 snd_printk(KERN_ERR "sscape: Error loading /*(DEBLOBBED)*/");
544                 return ret;
545         }
546         ret = upload_dma_data(sscape, init_fw->data, init_fw->size);
547
548         release_firmware(init_fw);
549
550         spin_lock_irqsave(&sscape->lock, flags);
551         if (ret == 0)
552                 data = host_read_ctrl_unsafe(sscape->io_base, 100);
553
554         if (data & 0x10)
555                 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2f);
556
557         spin_unlock_irqrestore(&sscape->lock, flags);
558
559         data &= 0xf;
560         if (ret == 0 && data > 7) {
561                 snd_printk(KERN_ERR
562                                 "sscape: timeout reading firmware version\n");
563                 ret = -EAGAIN;
564         }
565
566         return (ret == 0) ? data : ret;
567 }
568
569 /*
570  * Upload the microcode into the SoundScape.
571  */
572 static int sscape_upload_microcode(struct snd_card *card, int version)
573 {
574         struct soundscape *sscape = get_card_soundscape(card);
575         const struct firmware *init_fw = NULL;
576         char name[14];
577         int err;
578
579         snprintf(name, sizeof(name), "/*(DEBLOBBED)*/", version);
580
581         err = reject_firmware(&init_fw, name, card->dev);
582         if (err < 0) {
583                 snd_printk(KERN_ERR "sscape: Error loading /*(DEBLOBBED)*/",
584                                 version);
585                 return err;
586         }
587         err = upload_dma_data(sscape, init_fw->data, init_fw->size);
588         if (err == 0)
589                 snd_printk(KERN_INFO "sscape: MIDI firmware loaded %d KBs\n",
590                                 init_fw->size >> 10);
591
592         release_firmware(init_fw);
593
594         return err;
595 }
596
597 /*
598  * Mixer control for the SoundScape's MIDI device.
599  */
600 static int sscape_midi_info(struct snd_kcontrol *ctl,
601                             struct snd_ctl_elem_info *uinfo)
602 {
603         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
604         uinfo->count = 1;
605         uinfo->value.integer.min = 0;
606         uinfo->value.integer.max = 127;
607         return 0;
608 }
609
610 static int sscape_midi_get(struct snd_kcontrol *kctl,
611                            struct snd_ctl_elem_value *uctl)
612 {
613         struct snd_wss *chip = snd_kcontrol_chip(kctl);
614         struct snd_card *card = chip->card;
615         register struct soundscape *s = get_card_soundscape(card);
616         unsigned long flags;
617
618         spin_lock_irqsave(&s->lock, flags);
619         uctl->value.integer.value[0] = s->midi_vol;
620         spin_unlock_irqrestore(&s->lock, flags);
621         return 0;
622 }
623
624 static int sscape_midi_put(struct snd_kcontrol *kctl,
625                            struct snd_ctl_elem_value *uctl)
626 {
627         struct snd_wss *chip = snd_kcontrol_chip(kctl);
628         struct snd_card *card = chip->card;
629         struct soundscape *s = get_card_soundscape(card);
630         unsigned long flags;
631         int change;
632         unsigned char new_val;
633
634         spin_lock_irqsave(&s->lock, flags);
635
636         new_val = uctl->value.integer.value[0] & 127;
637         /*
638          * We need to put the board into HOST mode before we
639          * can send any volume-changing HOST commands ...
640          */
641         set_host_mode_unsafe(s->io_base);
642
643         /*
644          * To successfully change the MIDI volume setting, you seem to
645          * have to write a volume command, write the new volume value,
646          * and then perform another volume-related command. Perhaps the
647          * first command is an "open" and the second command is a "close"?
648          */
649         if (s->midi_vol == new_val) {
650                 change = 0;
651                 goto __skip_change;
652         }
653         change = host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
654                  && host_write_ctrl_unsafe(s->io_base, new_val, 100)
655                  && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100)
656                  && host_write_ctrl_unsafe(s->io_base, new_val, 100);
657         s->midi_vol = new_val;
658 __skip_change:
659
660         /*
661          * Take the board out of HOST mode and back into MIDI mode ...
662          */
663         set_midi_mode_unsafe(s->io_base);
664
665         spin_unlock_irqrestore(&s->lock, flags);
666         return change;
667 }
668
669 static struct snd_kcontrol_new midi_mixer_ctl = {
670         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
671         .name = "MIDI",
672         .info = sscape_midi_info,
673         .get = sscape_midi_get,
674         .put = sscape_midi_put
675 };
676
677 /*
678  * The SoundScape can use two IRQs from a possible set of four.
679  * These IRQs are encoded as bit patterns so that they can be
680  * written to the control registers.
681  */
682 static unsigned get_irq_config(int sscape_type, int irq)
683 {
684         static const int valid_irq[] = { 9, 5, 7, 10 };
685         static const int old_irq[] = { 9, 7, 5, 15 };
686         unsigned cfg;
687
688         if (sscape_type == MEDIA_FX) {
689                 for (cfg = 0; cfg < ARRAY_SIZE(old_irq); ++cfg)
690                         if (irq == old_irq[cfg])
691                                 return cfg;
692         } else {
693                 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg)
694                         if (irq == valid_irq[cfg])
695                                 return cfg;
696         }
697
698         return INVALID_IRQ;
699 }
700
701 /*
702  * Perform certain arcane port-checks to see whether there
703  * is a SoundScape board lurking behind the given ports.
704  */
705 static int detect_sscape(struct soundscape *s, long wss_io)
706 {
707         unsigned long flags;
708         unsigned d;
709         int retval = 0;
710
711         spin_lock_irqsave(&s->lock, flags);
712
713         /*
714          * The following code is lifted from the original OSS driver,
715          * and as I don't have a datasheet I cannot really comment
716          * on what it is doing...
717          */
718         if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
719                 goto _done;
720
721         d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
722         if ((d & 0x80) != 0)
723                 goto _done;
724
725         if (d == 0)
726                 s->ic_type = IC_ODIE;
727         else if ((d & 0x60) != 0)
728                 s->ic_type = IC_OPUS;
729         else
730                 goto _done;
731
732         outb(0xfa, ODIE_ADDR_IO(s->io_base));
733         if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
734                 goto _done;
735
736         outb(0xfe, ODIE_ADDR_IO(s->io_base));
737         if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
738                 goto _done;
739
740         outb(0xfe, ODIE_ADDR_IO(s->io_base));
741         d = inb(ODIE_DATA_IO(s->io_base));
742         if (s->type != SSCAPE_VIVO && (d & 0x9f) != 0x0e)
743                 goto _done;
744
745         if (s->ic_type == IC_OPUS)
746                 activate_ad1845_unsafe(s->io_base);
747
748         if (s->type == SSCAPE_VIVO)
749                 wss_io += 4;
750
751         d  = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
752         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
753
754         /* wait for WSS codec */
755         for (d = 0; d < 500; d++) {
756                 if ((inb(wss_io) & 0x80) == 0)
757                         break;
758                 spin_unlock_irqrestore(&s->lock, flags);
759                 msleep(1);
760                 spin_lock_irqsave(&s->lock, flags);
761         }
762
763         if ((inb(wss_io) & 0x80) != 0)
764                 goto _done;
765
766         if (inb(wss_io + 2) == 0xff)
767                 goto _done;
768
769         d  = sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f;
770         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d);
771
772         if ((inb(wss_io) & 0x80) != 0)
773                 s->type = MEDIA_FX;
774
775         d = sscape_read_unsafe(s->io_base, GA_HMCTL_REG);
776         sscape_write_unsafe(s->io_base, GA_HMCTL_REG, d | 0xc0);
777         /* wait for WSS codec */
778         for (d = 0; d < 500; d++) {
779                 if ((inb(wss_io) & 0x80) == 0)
780                         break;
781                 spin_unlock_irqrestore(&s->lock, flags);
782                 msleep(1);
783                 spin_lock_irqsave(&s->lock, flags);
784         }
785
786         /*
787          * SoundScape successfully detected!
788          */
789         retval = 1;
790
791 _done:
792         spin_unlock_irqrestore(&s->lock, flags);
793         return retval;
794 }
795
796 /*
797  * ALSA callback function, called when attempting to open the MIDI device.
798  * Check that the MIDI firmware has been loaded, because we don't want
799  * to crash the machine. Also check that someone isn't using the hardware
800  * IOCTL device.
801  */
802 static int mpu401_open(struct snd_mpu401 *mpu)
803 {
804         if (!verify_mpu401(mpu)) {
805                 snd_printk(KERN_ERR "sscape: MIDI disabled, "
806                                     "please load firmware\n");
807                 return -ENODEV;
808         }
809
810         return 0;
811 }
812
813 /*
814  * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
815  */
816 static int create_mpu401(struct snd_card *card, int devnum,
817                          unsigned long port, int irq)
818 {
819         struct soundscape *sscape = get_card_soundscape(card);
820         struct snd_rawmidi *rawmidi;
821         int err;
822
823         err = snd_mpu401_uart_new(card, devnum, MPU401_HW_MPU401, port,
824                                   MPU401_INFO_INTEGRATED, irq, &rawmidi);
825         if (err == 0) {
826                 struct snd_mpu401 *mpu = rawmidi->private_data;
827                 mpu->open_input = mpu401_open;
828                 mpu->open_output = mpu401_open;
829                 mpu->private_data = sscape;
830
831                 initialise_mpu401(mpu);
832         }
833
834         return err;
835 }
836
837
838 /*
839  * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
840  * is very much like a CS4231, with a few extra bits. We will
841  * try to support at least some of the extra bits by overriding
842  * some of the CS4231 callback.
843  */
844 static int create_ad1845(struct snd_card *card, unsigned port,
845                          int irq, int dma1, int dma2)
846 {
847         register struct soundscape *sscape = get_card_soundscape(card);
848         struct snd_wss *chip;
849         int err;
850         int codec_type = WSS_HW_DETECT;
851
852         switch (sscape->type) {
853         case MEDIA_FX:
854         case SSCAPE:
855                 /*
856                  * There are some freak examples of early Soundscape cards
857                  * with CS4231 instead of AD1848/CS4248. Unfortunately, the
858                  * CS4231 works only in CS4248 compatibility mode on
859                  * these cards so force it.
860                  */
861                 if (sscape->ic_type != IC_OPUS)
862                         codec_type = WSS_HW_AD1848;
863                 break;
864
865         case SSCAPE_VIVO:
866                 port += 4;
867                 break;
868         default:
869                 break;
870         }
871
872         err = snd_wss_create(card, port, -1, irq, dma1, dma2,
873                              codec_type, WSS_HWSHARE_DMA1, &chip);
874         if (!err) {
875                 unsigned long flags;
876
877                 if (sscape->type != SSCAPE_VIVO) {
878                         /*
879                          * The input clock frequency on the SoundScape must
880                          * be 14.31818 MHz, because we must set this register
881                          * to get the playback to sound correct ...
882                          */
883                         snd_wss_mce_up(chip);
884                         spin_lock_irqsave(&chip->reg_lock, flags);
885                         snd_wss_out(chip, AD1845_CLOCK, 0x20);
886                         spin_unlock_irqrestore(&chip->reg_lock, flags);
887                         snd_wss_mce_down(chip);
888
889                 }
890
891                 err = snd_wss_pcm(chip, 0);
892                 if (err < 0) {
893                         snd_printk(KERN_ERR "sscape: No PCM device "
894                                             "for AD1845 chip\n");
895                         goto _error;
896                 }
897
898                 err = snd_wss_mixer(chip);
899                 if (err < 0) {
900                         snd_printk(KERN_ERR "sscape: No mixer device "
901                                             "for AD1845 chip\n");
902                         goto _error;
903                 }
904                 if (chip->hardware != WSS_HW_AD1848) {
905                         err = snd_wss_timer(chip, 0);
906                         if (err < 0) {
907                                 snd_printk(KERN_ERR "sscape: No timer device "
908                                                     "for AD1845 chip\n");
909                                 goto _error;
910                         }
911                 }
912
913                 if (sscape->type != SSCAPE_VIVO) {
914                         err = snd_ctl_add(card,
915                                           snd_ctl_new1(&midi_mixer_ctl, chip));
916                         if (err < 0) {
917                                 snd_printk(KERN_ERR "sscape: Could not create "
918                                                     "MIDI mixer control\n");
919                                 goto _error;
920                         }
921                 }
922
923                 sscape->chip = chip;
924         }
925
926 _error:
927         return err;
928 }
929
930
931 /*
932  * Create an ALSA soundcard entry for the SoundScape, using
933  * the given list of port, IRQ and DMA resources.
934  */
935 static int create_sscape(int dev, struct snd_card *card)
936 {
937         struct soundscape *sscape = get_card_soundscape(card);
938         unsigned dma_cfg;
939         unsigned irq_cfg;
940         unsigned mpu_irq_cfg;
941         struct resource *io_res;
942         struct resource *wss_res;
943         unsigned long flags;
944         int err;
945         int val;
946         const char *name;
947
948         /*
949          * Grab IO ports that we will need to probe so that we
950          * can detect and control this hardware ...
951          */
952         io_res = request_region(port[dev], 8, "SoundScape");
953         if (!io_res) {
954                 snd_printk(KERN_ERR
955                            "sscape: can't grab port 0x%lx\n", port[dev]);
956                 return -EBUSY;
957         }
958         wss_res = NULL;
959         if (sscape->type == SSCAPE_VIVO) {
960                 wss_res = request_region(wss_port[dev], 4, "SoundScape");
961                 if (!wss_res) {
962                         snd_printk(KERN_ERR "sscape: can't grab port 0x%lx\n",
963                                             wss_port[dev]);
964                         err = -EBUSY;
965                         goto _release_region;
966                 }
967         }
968
969         /*
970          * Grab one DMA channel ...
971          */
972         err = request_dma(dma[dev], "SoundScape");
973         if (err < 0) {
974                 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", dma[dev]);
975                 goto _release_region;
976         }
977
978         spin_lock_init(&sscape->lock);
979         sscape->io_res = io_res;
980         sscape->wss_res = wss_res;
981         sscape->io_base = port[dev];
982
983         if (!detect_sscape(sscape, wss_port[dev])) {
984                 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n",
985                         sscape->io_base);
986                 err = -ENODEV;
987                 goto _release_dma;
988         }
989
990         switch (sscape->type) {
991         case MEDIA_FX:
992                 name = "MediaFX/SoundFX";
993                 break;
994         case SSCAPE:
995                 name = "Soundscape";
996                 break;
997         case SSCAPE_PNP:
998                 name = "Soundscape PnP";
999                 break;
1000         case SSCAPE_VIVO:
1001                 name = "Soundscape VIVO";
1002                 break;
1003         default:
1004                 name = "unknown Soundscape";
1005                 break;
1006         }
1007
1008         printk(KERN_INFO "sscape: %s card detected at 0x%x, using IRQ %d, DMA %d\n",
1009                          name, sscape->io_base, irq[dev], dma[dev]);
1010
1011         /*
1012          * Check that the user didn't pass us garbage data ...
1013          */
1014         irq_cfg = get_irq_config(sscape->type, irq[dev]);
1015         if (irq_cfg == INVALID_IRQ) {
1016                 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", irq[dev]);
1017                 err = -ENXIO;
1018                 goto _release_dma;
1019         }
1020
1021         mpu_irq_cfg = get_irq_config(sscape->type, mpu_irq[dev]);
1022         if (mpu_irq_cfg == INVALID_IRQ) {
1023                 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", mpu_irq[dev]);
1024                 err = -ENXIO;
1025                 goto _release_dma;
1026         }
1027
1028         /*
1029          * Tell the on-board devices where their resources are (I think -
1030          * I can't be sure without a datasheet ... So many magic values!)
1031          */
1032         spin_lock_irqsave(&sscape->lock, flags);
1033
1034         sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1035         sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1036
1037         /*
1038          * Enable and configure the DMA channels ...
1039          */
1040         sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1041         dma_cfg = (sscape->ic_type == IC_OPUS ? 0x40 : 0x70);
1042         sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1043         sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1044
1045         mpu_irq_cfg |= mpu_irq_cfg << 2;
1046         val = sscape_read_unsafe(sscape->io_base, GA_HMCTL_REG) & 0xF7;
1047         if (joystick[dev])
1048                 val |= 8;
1049         sscape_write_unsafe(sscape->io_base, GA_HMCTL_REG, val | 0x10);
1050         sscape_write_unsafe(sscape->io_base, GA_INTCFG_REG, 0xf0 | mpu_irq_cfg);
1051         sscape_write_unsafe(sscape->io_base,
1052                             GA_CDCFG_REG, 0x09 | DMA_8BIT
1053                             | (dma[dev] << 4) | (irq_cfg << 1));
1054         /*
1055          * Enable the master IRQ ...
1056          */
1057         sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x80);
1058
1059         spin_unlock_irqrestore(&sscape->lock, flags);
1060
1061         /*
1062          * We have now enabled the codec chip, and so we should
1063          * detect the AD1845 device ...
1064          */
1065         err = create_ad1845(card, wss_port[dev], irq[dev],
1066                             dma[dev], dma2[dev]);
1067         if (err < 0) {
1068                 snd_printk(KERN_ERR
1069                                 "sscape: No AD1845 device at 0x%lx, IRQ %d\n",
1070                                 wss_port[dev], irq[dev]);
1071                 goto _release_dma;
1072         }
1073         strcpy(card->driver, "SoundScape");
1074         strcpy(card->shortname, name);
1075         snprintf(card->longname, sizeof(card->longname),
1076                  "%s at 0x%lx, IRQ %d, DMA1 %d, DMA2 %d\n",
1077                  name, sscape->chip->port, sscape->chip->irq,
1078                  sscape->chip->dma1, sscape->chip->dma2);
1079
1080 #define MIDI_DEVNUM  0
1081         if (sscape->type != SSCAPE_VIVO) {
1082                 err = sscape_upload_bootblock(card);
1083                 if (err >= 0)
1084                         err = sscape_upload_microcode(card, err);
1085
1086                 if (err == 0) {
1087                         err = create_mpu401(card, MIDI_DEVNUM, port[dev],
1088                                             mpu_irq[dev]);
1089                         if (err < 0) {
1090                                 snd_printk(KERN_ERR "sscape: Failed to create "
1091                                                 "MPU-401 device at 0x%lx\n",
1092                                                 port[dev]);
1093                                 goto _release_dma;
1094                         }
1095
1096                         /*
1097                          * Initialize mixer
1098                          */
1099                         spin_lock_irqsave(&sscape->lock, flags);
1100                         sscape->midi_vol = 0;
1101                         host_write_ctrl_unsafe(sscape->io_base,
1102                                                 CMD_SET_MIDI_VOL, 100);
1103                         host_write_ctrl_unsafe(sscape->io_base,
1104                                                 sscape->midi_vol, 100);
1105                         host_write_ctrl_unsafe(sscape->io_base,
1106                                                 CMD_XXX_MIDI_VOL, 100);
1107                         host_write_ctrl_unsafe(sscape->io_base,
1108                                                 sscape->midi_vol, 100);
1109                         host_write_ctrl_unsafe(sscape->io_base,
1110                                                 CMD_SET_EXTMIDI, 100);
1111                         host_write_ctrl_unsafe(sscape->io_base,
1112                                                 0, 100);
1113                         host_write_ctrl_unsafe(sscape->io_base, CMD_ACK, 100);
1114
1115                         set_midi_mode_unsafe(sscape->io_base);
1116                         spin_unlock_irqrestore(&sscape->lock, flags);
1117                 }
1118         }
1119
1120         /*
1121          * Now that we have successfully created this sound card,
1122          * it is safe to store the pointer.
1123          * NOTE: we only register the sound card's "destructor"
1124          *       function now that our "constructor" has completed.
1125          */
1126         card->private_free = soundscape_free;
1127
1128         return 0;
1129
1130 _release_dma:
1131         free_dma(dma[dev]);
1132
1133 _release_region:
1134         release_and_free_resource(wss_res);
1135         release_and_free_resource(io_res);
1136
1137         return err;
1138 }
1139
1140
1141 static int snd_sscape_match(struct device *pdev, unsigned int i)
1142 {
1143         /*
1144          * Make sure we were given ALL of the other parameters.
1145          */
1146         if (port[i] == SNDRV_AUTO_PORT)
1147                 return 0;
1148
1149         if (irq[i] == SNDRV_AUTO_IRQ ||
1150             mpu_irq[i] == SNDRV_AUTO_IRQ ||
1151             dma[i] == SNDRV_AUTO_DMA) {
1152                 printk(KERN_INFO
1153                        "sscape: insufficient parameters, "
1154                        "need IO, IRQ, MPU-IRQ and DMA\n");
1155                 return 0;
1156         }
1157
1158         return 1;
1159 }
1160
1161 static int snd_sscape_probe(struct device *pdev, unsigned int dev)
1162 {
1163         struct snd_card *card;
1164         struct soundscape *sscape;
1165         int ret;
1166
1167         ret = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
1168                            sizeof(struct soundscape), &card);
1169         if (ret < 0)
1170                 return ret;
1171
1172         sscape = get_card_soundscape(card);
1173         sscape->type = SSCAPE;
1174
1175         dma[dev] &= 0x03;
1176
1177         ret = create_sscape(dev, card);
1178         if (ret < 0)
1179                 goto _release_card;
1180
1181         ret = snd_card_register(card);
1182         if (ret < 0) {
1183                 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1184                 goto _release_card;
1185         }
1186         dev_set_drvdata(pdev, card);
1187         return 0;
1188
1189 _release_card:
1190         snd_card_free(card);
1191         return ret;
1192 }
1193
1194 static int snd_sscape_remove(struct device *devptr, unsigned int dev)
1195 {
1196         snd_card_free(dev_get_drvdata(devptr));
1197         return 0;
1198 }
1199
1200 #define DEV_NAME "sscape"
1201
1202 static struct isa_driver snd_sscape_driver = {
1203         .match          = snd_sscape_match,
1204         .probe          = snd_sscape_probe,
1205         .remove         = snd_sscape_remove,
1206         /* FIXME: suspend/resume */
1207         .driver         = {
1208                 .name   = DEV_NAME
1209         },
1210 };
1211
1212 #ifdef CONFIG_PNP
1213 static inline int get_next_autoindex(int i)
1214 {
1215         while (i < SNDRV_CARDS && port[i] != SNDRV_AUTO_PORT)
1216                 ++i;
1217         return i;
1218 }
1219
1220
1221 static int sscape_pnp_detect(struct pnp_card_link *pcard,
1222                              const struct pnp_card_device_id *pid)
1223 {
1224         static int idx = 0;
1225         struct pnp_dev *dev;
1226         struct snd_card *card;
1227         struct soundscape *sscape;
1228         int ret;
1229
1230         /*
1231          * Allow this function to fail *quietly* if all the ISA PnP
1232          * devices were configured using module parameters instead.
1233          */
1234         idx = get_next_autoindex(idx);
1235         if (idx >= SNDRV_CARDS)
1236                 return -ENOSPC;
1237
1238         /*
1239          * Check that we still have room for another sound card ...
1240          */
1241         dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1242         if (!dev)
1243                 return -ENODEV;
1244
1245         if (!pnp_is_active(dev)) {
1246                 if (pnp_activate_dev(dev) < 0) {
1247                         snd_printk(KERN_INFO "sscape: device is inactive\n");
1248                         return -EBUSY;
1249                 }
1250         }
1251
1252         /*
1253          * Create a new ALSA sound card entry, in anticipation
1254          * of detecting our hardware ...
1255          */
1256         ret = snd_card_new(&pcard->card->dev,
1257                            index[idx], id[idx], THIS_MODULE,
1258                            sizeof(struct soundscape), &card);
1259         if (ret < 0)
1260                 return ret;
1261
1262         sscape = get_card_soundscape(card);
1263
1264         /*
1265          * Identify card model ...
1266          */
1267         if (!strncmp("ENS4081", pid->id, 7))
1268                 sscape->type = SSCAPE_VIVO;
1269         else
1270                 sscape->type = SSCAPE_PNP;
1271
1272         /*
1273          * Read the correct parameters off the ISA PnP bus ...
1274          */
1275         port[idx] = pnp_port_start(dev, 0);
1276         irq[idx] = pnp_irq(dev, 0);
1277         mpu_irq[idx] = pnp_irq(dev, 1);
1278         dma[idx] = pnp_dma(dev, 0) & 0x03;
1279         if (sscape->type == SSCAPE_PNP) {
1280                 dma2[idx] = dma[idx];
1281                 wss_port[idx] = CODEC_IO(port[idx]);
1282         } else {
1283                 wss_port[idx] = pnp_port_start(dev, 1);
1284                 dma2[idx] = pnp_dma(dev, 1);
1285         }
1286
1287         ret = create_sscape(idx, card);
1288         if (ret < 0)
1289                 goto _release_card;
1290
1291         ret = snd_card_register(card);
1292         if (ret < 0) {
1293                 snd_printk(KERN_ERR "sscape: Failed to register sound card\n");
1294                 goto _release_card;
1295         }
1296
1297         pnp_set_card_drvdata(pcard, card);
1298         ++idx;
1299         return 0;
1300
1301 _release_card:
1302         snd_card_free(card);
1303         return ret;
1304 }
1305
1306 static void sscape_pnp_remove(struct pnp_card_link *pcard)
1307 {
1308         snd_card_free(pnp_get_card_drvdata(pcard));
1309         pnp_set_card_drvdata(pcard, NULL);
1310 }
1311
1312 static struct pnp_card_driver sscape_pnpc_driver = {
1313         .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1314         .name = "sscape",
1315         .id_table = sscape_pnpids,
1316         .probe = sscape_pnp_detect,
1317         .remove = sscape_pnp_remove,
1318 };
1319
1320 #endif /* CONFIG_PNP */
1321
1322 static int __init sscape_init(void)
1323 {
1324         int err;
1325
1326         err = isa_register_driver(&snd_sscape_driver, SNDRV_CARDS);
1327 #ifdef CONFIG_PNP
1328         if (!err)
1329                 isa_registered = 1;
1330
1331         err = pnp_register_card_driver(&sscape_pnpc_driver);
1332         if (!err)
1333                 pnp_registered = 1;
1334
1335         if (isa_registered)
1336                 err = 0;
1337 #endif
1338         return err;
1339 }
1340
1341 static void __exit sscape_exit(void)
1342 {
1343 #ifdef CONFIG_PNP
1344         if (pnp_registered)
1345                 pnp_unregister_card_driver(&sscape_pnpc_driver);
1346         if (isa_registered)
1347 #endif
1348                 isa_unregister_driver(&snd_sscape_driver);
1349 }
1350
1351 module_init(sscape_init);
1352 module_exit(sscape_exit);