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